UNPKG

@octokit/graphql-schema

Version:

GitHub’s GraphQL Schema with validation. Automatically updated.

1,052 lines (966 loc) 1.3 MB
export type Maybe<T> = T | null; export type InputMaybe<T> = Maybe<T>; export type Exact<T extends { [key: string]: unknown }> = { [K in keyof T]: T[K] }; export type MakeOptional<T, K extends keyof T> = Omit<T, K> & { [SubKey in K]?: Maybe<T[SubKey]> }; export type MakeMaybe<T, K extends keyof T> = Omit<T, K> & { [SubKey in K]: Maybe<T[SubKey]> }; export type MakeEmpty<T extends { [key: string]: unknown }, K extends keyof T> = { [_ in K]?: never }; export type Incremental<T> = T | { [P in keyof T]?: P extends ' $fragmentName' | '__typename' ? T[P] : never }; /** All built-in and custom scalars, mapped to their actual values */ export type Scalars = { ID: { input: string; output: string; } String: { input: string; output: string; } Boolean: { input: boolean; output: boolean; } Int: { input: number; output: number; } Float: { input: number; output: number; } /** A (potentially binary) string encoded using base64. */ Base64String: { input: any; output: any; } /** * Represents non-fractional signed whole numeric values. Since the value may * exceed the size of a 32-bit integer, it's encoded as a string. */ BigInt: { input: any; output: any; } /** An ISO-8601 encoded date string. */ Date: { input: any; output: any; } /** An ISO-8601 encoded UTC date string. */ DateTime: { input: any; output: any; } /** A Git object ID. */ GitObjectID: { input: any; output: any; } /** A fully qualified reference name (e.g. `refs/heads/master`). */ GitRefname: { input: any; output: any; } /** Git SSH string */ GitSSHRemote: { input: any; output: any; } /** An ISO-8601 encoded date string. Unlike the DateTime type, GitTimestamp is not converted in UTC. */ GitTimestamp: { input: any; output: any; } /** A string containing HTML code. */ HTML: { input: any; output: any; } /** An ISO-8601 encoded UTC date string with millisecond precision. */ PreciseDateTime: { input: any; output: any; } /** An RFC 3986, RFC 3987, and RFC 6570 (level 4) compliant URI string. */ URI: { input: any; output: any; } /** A valid x509 certificate string */ X509Certificate: { input: any; output: any; } }; /** Autogenerated input type of AbortQueuedMigrations */ export type AbortQueuedMigrationsInput = { /** A unique identifier for the client performing the mutation. */ clientMutationId?: InputMaybe<Scalars['String']['input']>; /** The ID of the organization that is running the migrations. */ ownerId: Scalars['ID']['input']; }; /** Autogenerated return type of AbortQueuedMigrations. */ export type AbortQueuedMigrationsPayload = { __typename?: 'AbortQueuedMigrationsPayload'; /** A unique identifier for the client performing the mutation. */ clientMutationId?: Maybe<Scalars['String']['output']>; /** Did the operation succeed? */ success?: Maybe<Scalars['Boolean']['output']>; }; /** Autogenerated input type of AbortRepositoryMigration */ export type AbortRepositoryMigrationInput = { /** A unique identifier for the client performing the mutation. */ clientMutationId?: InputMaybe<Scalars['String']['input']>; /** The ID of the migration to be aborted. */ migrationId: Scalars['ID']['input']; }; /** Autogenerated return type of AbortRepositoryMigration. */ export type AbortRepositoryMigrationPayload = { __typename?: 'AbortRepositoryMigrationPayload'; /** A unique identifier for the client performing the mutation. */ clientMutationId?: Maybe<Scalars['String']['output']>; /** Did the operation succeed? */ success?: Maybe<Scalars['Boolean']['output']>; }; /** Autogenerated input type of AcceptEnterpriseAdministratorInvitation */ export type AcceptEnterpriseAdministratorInvitationInput = { /** A unique identifier for the client performing the mutation. */ clientMutationId?: InputMaybe<Scalars['String']['input']>; /** The id of the invitation being accepted */ invitationId: Scalars['ID']['input']; }; /** Autogenerated return type of AcceptEnterpriseAdministratorInvitation. */ export type AcceptEnterpriseAdministratorInvitationPayload = { __typename?: 'AcceptEnterpriseAdministratorInvitationPayload'; /** A unique identifier for the client performing the mutation. */ clientMutationId?: Maybe<Scalars['String']['output']>; /** The invitation that was accepted. */ invitation?: Maybe<EnterpriseAdministratorInvitation>; /** A message confirming the result of accepting an administrator invitation. */ message?: Maybe<Scalars['String']['output']>; }; /** Autogenerated input type of AcceptEnterpriseMemberInvitation */ export type AcceptEnterpriseMemberInvitationInput = { /** A unique identifier for the client performing the mutation. */ clientMutationId?: InputMaybe<Scalars['String']['input']>; /** The id of the invitation being accepted */ invitationId: Scalars['ID']['input']; }; /** Autogenerated return type of AcceptEnterpriseMemberInvitation. */ export type AcceptEnterpriseMemberInvitationPayload = { __typename?: 'AcceptEnterpriseMemberInvitationPayload'; /** A unique identifier for the client performing the mutation. */ clientMutationId?: Maybe<Scalars['String']['output']>; /** The invitation that was accepted. */ invitation?: Maybe<EnterpriseMemberInvitation>; /** A message confirming the result of accepting an unaffiliated member invitation. */ message?: Maybe<Scalars['String']['output']>; }; /** Autogenerated input type of AcceptTopicSuggestion */ export type AcceptTopicSuggestionInput = { /** A unique identifier for the client performing the mutation. */ clientMutationId?: InputMaybe<Scalars['String']['input']>; /** * The name of the suggested topic. * * **Upcoming Change on 2024-04-01 UTC** * **Description:** `name` will be removed. * **Reason:** Suggested topics are no longer supported */ name?: InputMaybe<Scalars['String']['input']>; /** * The Node ID of the repository. * * **Upcoming Change on 2024-04-01 UTC** * **Description:** `repositoryId` will be removed. * **Reason:** Suggested topics are no longer supported */ repositoryId?: InputMaybe<Scalars['ID']['input']>; }; /** Autogenerated return type of AcceptTopicSuggestion. */ export type AcceptTopicSuggestionPayload = { __typename?: 'AcceptTopicSuggestionPayload'; /** A unique identifier for the client performing the mutation. */ clientMutationId?: Maybe<Scalars['String']['output']>; /** * The accepted topic. * @deprecated Suggested topics are no longer supported Removal on 2024-04-01 UTC. */ topic?: Maybe<Topic>; }; /** Represents an object which can take actions on GitHub. Typically a User or Bot. */ export type Actor = { /** A URL pointing to the actor's public avatar. */ avatarUrl: Scalars['URI']['output']; /** The username of the actor. */ login: Scalars['String']['output']; /** The HTTP path for this actor. */ resourcePath: Scalars['URI']['output']; /** The HTTP URL for this actor. */ url: Scalars['URI']['output']; }; /** Represents an object which can take actions on GitHub. Typically a User or Bot. */ export type ActorAvatarUrlArgs = { size?: InputMaybe<Scalars['Int']['input']>; }; /** Location information for an actor */ export type ActorLocation = { __typename?: 'ActorLocation'; /** City */ city?: Maybe<Scalars['String']['output']>; /** Country name */ country?: Maybe<Scalars['String']['output']>; /** Country code */ countryCode?: Maybe<Scalars['String']['output']>; /** Region name */ region?: Maybe<Scalars['String']['output']>; /** Region or state code */ regionCode?: Maybe<Scalars['String']['output']>; }; /** The actor's type. */ export type ActorType = /** Indicates a team actor. */ | 'TEAM' /** Indicates a user actor. */ | 'USER'; /** Autogenerated input type of AddAssigneesToAssignable */ export type AddAssigneesToAssignableInput = { /** The id of the assignable object to add assignees to. */ assignableId: Scalars['ID']['input']; /** The id of users to add as assignees. */ assigneeIds: Array<Scalars['ID']['input']>; /** A unique identifier for the client performing the mutation. */ clientMutationId?: InputMaybe<Scalars['String']['input']>; }; /** Autogenerated return type of AddAssigneesToAssignable. */ export type AddAssigneesToAssignablePayload = { __typename?: 'AddAssigneesToAssignablePayload'; /** The item that was assigned. */ assignable?: Maybe<Issue | PullRequest>; /** A unique identifier for the client performing the mutation. */ clientMutationId?: Maybe<Scalars['String']['output']>; }; /** Autogenerated input type of AddComment */ export type AddCommentInput = { /** The contents of the comment. */ body: Scalars['String']['input']; /** A unique identifier for the client performing the mutation. */ clientMutationId?: InputMaybe<Scalars['String']['input']>; /** The Node ID of the subject to modify. */ subjectId: Scalars['ID']['input']; }; /** Autogenerated return type of AddComment. */ export type AddCommentPayload = { __typename?: 'AddCommentPayload'; /** A unique identifier for the client performing the mutation. */ clientMutationId?: Maybe<Scalars['String']['output']>; /** The edge from the subject's comment connection. */ commentEdge?: Maybe<IssueCommentEdge>; /** The subject */ subject?: Maybe<AddedToMergeQueueEvent | AddedToProjectEvent | App | AssignedEvent | AutoMergeDisabledEvent | AutoMergeEnabledEvent | AutoRebaseEnabledEvent | AutoSquashEnabledEvent | AutomaticBaseChangeFailedEvent | AutomaticBaseChangeSucceededEvent | BaseRefChangedEvent | BaseRefDeletedEvent | BaseRefForcePushedEvent | Blob | Bot | BranchProtectionRule | BypassForcePushAllowance | BypassPullRequestAllowance | Cwe | CheckRun | CheckSuite | ClosedEvent | CodeOfConduct | CommentDeletedEvent | Commit | CommitComment | CommitCommentThread | Comparison | ConnectedEvent | ConvertToDraftEvent | ConvertedNoteToIssueEvent | ConvertedToDiscussionEvent | CrossReferencedEvent | DemilestonedEvent | DependencyGraphManifest | DeployKey | DeployedEvent | Deployment | DeploymentEnvironmentChangedEvent | DeploymentReview | DeploymentStatus | DisconnectedEvent | Discussion | DiscussionCategory | DiscussionComment | DiscussionPoll | DiscussionPollOption | DraftIssue | Enterprise | EnterpriseAdministratorInvitation | EnterpriseIdentityProvider | EnterpriseMemberInvitation | EnterpriseRepositoryInfo | EnterpriseServerInstallation | EnterpriseServerUserAccount | EnterpriseServerUserAccountEmail | EnterpriseServerUserAccountsUpload | EnterpriseUserAccount | Environment | ExternalIdentity | Gist | GistComment | HeadRefDeletedEvent | HeadRefForcePushedEvent | HeadRefRestoredEvent | IpAllowListEntry | Issue | IssueComment | Label | LabeledEvent | Language | License | LinkedBranch | LockedEvent | Mannequin | MarkedAsDuplicateEvent | MarketplaceCategory | MarketplaceListing | MemberFeatureRequestNotification | MembersCanDeleteReposClearAuditEntry | MembersCanDeleteReposDisableAuditEntry | MembersCanDeleteReposEnableAuditEntry | MentionedEvent | MergeQueue | MergeQueueEntry | MergedEvent | MigrationSource | Milestone | MilestonedEvent | MovedColumnsInProjectEvent | OidcProvider | OauthApplicationCreateAuditEntry | OrgAddBillingManagerAuditEntry | OrgAddMemberAuditEntry | OrgBlockUserAuditEntry | OrgConfigDisableCollaboratorsOnlyAuditEntry | OrgConfigEnableCollaboratorsOnlyAuditEntry | OrgCreateAuditEntry | OrgDisableOauthAppRestrictionsAuditEntry | OrgDisableSamlAuditEntry | OrgDisableTwoFactorRequirementAuditEntry | OrgEnableOauthAppRestrictionsAuditEntry | OrgEnableSamlAuditEntry | OrgEnableTwoFactorRequirementAuditEntry | OrgInviteMemberAuditEntry | OrgInviteToBusinessAuditEntry | OrgOauthAppAccessApprovedAuditEntry | OrgOauthAppAccessBlockedAuditEntry | OrgOauthAppAccessDeniedAuditEntry | OrgOauthAppAccessRequestedAuditEntry | OrgOauthAppAccessUnblockedAuditEntry | OrgRemoveBillingManagerAuditEntry | OrgRemoveMemberAuditEntry | OrgRemoveOutsideCollaboratorAuditEntry | OrgRestoreMemberAuditEntry | OrgUnblockUserAuditEntry | OrgUpdateDefaultRepositoryPermissionAuditEntry | OrgUpdateMemberAuditEntry | OrgUpdateMemberRepositoryCreationPermissionAuditEntry | OrgUpdateMemberRepositoryInvitationPermissionAuditEntry | Organization | OrganizationIdentityProvider | OrganizationInvitation | OrganizationMigration | Package | PackageFile | PackageTag | PackageVersion | PinnedDiscussion | PinnedEnvironment | PinnedEvent | PinnedIssue | PrivateRepositoryForkingDisableAuditEntry | PrivateRepositoryForkingEnableAuditEntry | Project | ProjectCard | ProjectColumn | ProjectV2 | ProjectV2Field | ProjectV2Item | ProjectV2ItemFieldDateValue | ProjectV2ItemFieldIterationValue | ProjectV2ItemFieldNumberValue | ProjectV2ItemFieldSingleSelectValue | ProjectV2ItemFieldTextValue | ProjectV2IterationField | ProjectV2SingleSelectField | ProjectV2StatusUpdate | ProjectV2View | ProjectV2Workflow | PublicKey | PullRequest | PullRequestCommit | PullRequestCommitCommentThread | PullRequestReview | PullRequestReviewComment | PullRequestReviewThread | PullRequestThread | Push | PushAllowance | Reaction | ReadyForReviewEvent | Ref | ReferencedEvent | Release | ReleaseAsset | RemovedFromMergeQueueEvent | RemovedFromProjectEvent | RenamedTitleEvent | ReopenedEvent | RepoAccessAuditEntry | RepoAddMemberAuditEntry | RepoAddTopicAuditEntry | RepoArchivedAuditEntry | RepoChangeMergeSettingAuditEntry | RepoConfigDisableAnonymousGitAccessAuditEntry | RepoConfigDisableCollaboratorsOnlyAuditEntry | RepoConfigDisableContributorsOnlyAuditEntry | RepoConfigDisableSockpuppetDisallowedAuditEntry | RepoConfigEnableAnonymousGitAccessAuditEntry | RepoConfigEnableCollaboratorsOnlyAuditEntry | RepoConfigEnableContributorsOnlyAuditEntry | RepoConfigEnableSockpuppetDisallowedAuditEntry | RepoConfigLockAnonymousGitAccessAuditEntry | RepoConfigUnlockAnonymousGitAccessAuditEntry | RepoCreateAuditEntry | RepoDestroyAuditEntry | RepoRemoveMemberAuditEntry | RepoRemoveTopicAuditEntry | Repository | RepositoryInvitation | RepositoryMigration | RepositoryRule | RepositoryRuleset | RepositoryRulesetBypassActor | RepositoryTopic | RepositoryVisibilityChangeDisableAuditEntry | RepositoryVisibilityChangeEnableAuditEntry | RepositoryVulnerabilityAlert | ReviewDismissalAllowance | ReviewDismissedEvent | ReviewRequest | ReviewRequestRemovedEvent | ReviewRequestedEvent | SavedReply | SecurityAdvisory | SponsorsActivity | SponsorsListing | SponsorsListingFeaturedItem | SponsorsTier | Sponsorship | SponsorshipNewsletter | Status | StatusCheckRollup | StatusContext | SubscribedEvent | Tag | Team | TeamAddMemberAuditEntry | TeamAddRepositoryAuditEntry | TeamChangeParentTeamAuditEntry | TeamDiscussion | TeamDiscussionComment | TeamRemoveMemberAuditEntry | TeamRemoveRepositoryAuditEntry | Topic | TransferredEvent | Tree | UnassignedEvent | UnlabeledEvent | UnlockedEvent | UnmarkedAsDuplicateEvent | UnpinnedEvent | UnsubscribedEvent | User | UserBlockedEvent | UserContentEdit | UserList | UserStatus | VerifiableDomain | Workflow | WorkflowRun | WorkflowRunFile>; /** The edge from the subject's timeline connection. */ timelineEdge?: Maybe<IssueTimelineItemEdge>; }; /** Autogenerated input type of AddDiscussionComment */ export type AddDiscussionCommentInput = { /** The contents of the comment. */ body: Scalars['String']['input']; /** A unique identifier for the client performing the mutation. */ clientMutationId?: InputMaybe<Scalars['String']['input']>; /** The Node ID of the discussion to comment on. */ discussionId: Scalars['ID']['input']; /** The Node ID of the discussion comment within this discussion to reply to. */ replyToId?: InputMaybe<Scalars['ID']['input']>; }; /** Autogenerated return type of AddDiscussionComment. */ export type AddDiscussionCommentPayload = { __typename?: 'AddDiscussionCommentPayload'; /** A unique identifier for the client performing the mutation. */ clientMutationId?: Maybe<Scalars['String']['output']>; /** The newly created discussion comment. */ comment?: Maybe<DiscussionComment>; }; /** Autogenerated input type of AddDiscussionPollVote */ export type AddDiscussionPollVoteInput = { /** A unique identifier for the client performing the mutation. */ clientMutationId?: InputMaybe<Scalars['String']['input']>; /** The Node ID of the discussion poll option to vote for. */ pollOptionId: Scalars['ID']['input']; }; /** Autogenerated return type of AddDiscussionPollVote. */ export type AddDiscussionPollVotePayload = { __typename?: 'AddDiscussionPollVotePayload'; /** A unique identifier for the client performing the mutation. */ clientMutationId?: Maybe<Scalars['String']['output']>; /** The poll option that a vote was added to. */ pollOption?: Maybe<DiscussionPollOption>; }; /** Autogenerated input type of AddEnterpriseOrganizationMember */ export type AddEnterpriseOrganizationMemberInput = { /** A unique identifier for the client performing the mutation. */ clientMutationId?: InputMaybe<Scalars['String']['input']>; /** The ID of the enterprise which owns the organization. */ enterpriseId: Scalars['ID']['input']; /** The ID of the organization the users will be added to. */ organizationId: Scalars['ID']['input']; /** The role to assign the users in the organization */ role?: InputMaybe<OrganizationMemberRole>; /** The IDs of the enterprise members to add. */ userIds: Array<Scalars['ID']['input']>; }; /** Autogenerated return type of AddEnterpriseOrganizationMember. */ export type AddEnterpriseOrganizationMemberPayload = { __typename?: 'AddEnterpriseOrganizationMemberPayload'; /** A unique identifier for the client performing the mutation. */ clientMutationId?: Maybe<Scalars['String']['output']>; /** The users who were added to the organization. */ users?: Maybe<Array<User>>; }; /** Autogenerated input type of AddEnterpriseSupportEntitlement */ export type AddEnterpriseSupportEntitlementInput = { /** A unique identifier for the client performing the mutation. */ clientMutationId?: InputMaybe<Scalars['String']['input']>; /** The ID of the Enterprise which the admin belongs to. */ enterpriseId: Scalars['ID']['input']; /** The login of a member who will receive the support entitlement. */ login: Scalars['String']['input']; }; /** Autogenerated return type of AddEnterpriseSupportEntitlement. */ export type AddEnterpriseSupportEntitlementPayload = { __typename?: 'AddEnterpriseSupportEntitlementPayload'; /** A unique identifier for the client performing the mutation. */ clientMutationId?: Maybe<Scalars['String']['output']>; /** A message confirming the result of adding the support entitlement. */ message?: Maybe<Scalars['String']['output']>; }; /** Autogenerated input type of AddLabelsToLabelable */ export type AddLabelsToLabelableInput = { /** A unique identifier for the client performing the mutation. */ clientMutationId?: InputMaybe<Scalars['String']['input']>; /** The ids of the labels to add. */ labelIds: Array<Scalars['ID']['input']>; /** The id of the labelable object to add labels to. */ labelableId: Scalars['ID']['input']; }; /** Autogenerated return type of AddLabelsToLabelable. */ export type AddLabelsToLabelablePayload = { __typename?: 'AddLabelsToLabelablePayload'; /** A unique identifier for the client performing the mutation. */ clientMutationId?: Maybe<Scalars['String']['output']>; /** The item that was labeled. */ labelable?: Maybe<Discussion | Issue | PullRequest>; }; /** Autogenerated input type of AddProjectCard */ export type AddProjectCardInput = { /** A unique identifier for the client performing the mutation. */ clientMutationId?: InputMaybe<Scalars['String']['input']>; /** The content of the card. Must be a member of the ProjectCardItem union */ contentId?: InputMaybe<Scalars['ID']['input']>; /** The note on the card. */ note?: InputMaybe<Scalars['String']['input']>; /** The Node ID of the ProjectColumn. */ projectColumnId: Scalars['ID']['input']; }; /** Autogenerated return type of AddProjectCard. */ export type AddProjectCardPayload = { __typename?: 'AddProjectCardPayload'; /** The edge from the ProjectColumn's card connection. */ cardEdge?: Maybe<ProjectCardEdge>; /** A unique identifier for the client performing the mutation. */ clientMutationId?: Maybe<Scalars['String']['output']>; /** The ProjectColumn */ projectColumn?: Maybe<ProjectColumn>; }; /** Autogenerated input type of AddProjectColumn */ export type AddProjectColumnInput = { /** A unique identifier for the client performing the mutation. */ clientMutationId?: InputMaybe<Scalars['String']['input']>; /** The name of the column. */ name: Scalars['String']['input']; /** The Node ID of the project. */ projectId: Scalars['ID']['input']; }; /** Autogenerated return type of AddProjectColumn. */ export type AddProjectColumnPayload = { __typename?: 'AddProjectColumnPayload'; /** A unique identifier for the client performing the mutation. */ clientMutationId?: Maybe<Scalars['String']['output']>; /** The edge from the project's column connection. */ columnEdge?: Maybe<ProjectColumnEdge>; /** The project */ project?: Maybe<Project>; }; /** Autogenerated input type of AddProjectV2DraftIssue */ export type AddProjectV2DraftIssueInput = { /** The IDs of the assignees of the draft issue. */ assigneeIds?: InputMaybe<Array<Scalars['ID']['input']>>; /** The body of the draft issue. */ body?: InputMaybe<Scalars['String']['input']>; /** A unique identifier for the client performing the mutation. */ clientMutationId?: InputMaybe<Scalars['String']['input']>; /** The ID of the Project to add the draft issue to. */ projectId: Scalars['ID']['input']; /** * The title of the draft issue. A project item can also be created by providing * the URL of an Issue or Pull Request if you have access. */ title: Scalars['String']['input']; }; /** Autogenerated return type of AddProjectV2DraftIssue. */ export type AddProjectV2DraftIssuePayload = { __typename?: 'AddProjectV2DraftIssuePayload'; /** A unique identifier for the client performing the mutation. */ clientMutationId?: Maybe<Scalars['String']['output']>; /** The draft issue added to the project. */ projectItem?: Maybe<ProjectV2Item>; }; /** Autogenerated input type of AddProjectV2ItemById */ export type AddProjectV2ItemByIdInput = { /** A unique identifier for the client performing the mutation. */ clientMutationId?: InputMaybe<Scalars['String']['input']>; /** The id of the Issue or Pull Request to add. */ contentId: Scalars['ID']['input']; /** The ID of the Project to add the item to. */ projectId: Scalars['ID']['input']; }; /** Autogenerated return type of AddProjectV2ItemById. */ export type AddProjectV2ItemByIdPayload = { __typename?: 'AddProjectV2ItemByIdPayload'; /** A unique identifier for the client performing the mutation. */ clientMutationId?: Maybe<Scalars['String']['output']>; /** The item added to the project. */ item?: Maybe<ProjectV2Item>; }; /** Autogenerated input type of AddPullRequestReviewComment */ export type AddPullRequestReviewCommentInput = { /** * The text of the comment. This field is required * * **Upcoming Change on 2023-10-01 UTC** * **Description:** `body` will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply instead * **Reason:** We are deprecating the addPullRequestReviewComment mutation */ body?: InputMaybe<Scalars['String']['input']>; /** A unique identifier for the client performing the mutation. */ clientMutationId?: InputMaybe<Scalars['String']['input']>; /** * The SHA of the commit to comment on. * * **Upcoming Change on 2023-10-01 UTC** * **Description:** `commitOID` will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply instead * **Reason:** We are deprecating the addPullRequestReviewComment mutation */ commitOID?: InputMaybe<Scalars['GitObjectID']['input']>; /** * The comment id to reply to. * * **Upcoming Change on 2023-10-01 UTC** * **Description:** `inReplyTo` will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply instead * **Reason:** We are deprecating the addPullRequestReviewComment mutation */ inReplyTo?: InputMaybe<Scalars['ID']['input']>; /** * The relative path of the file to comment on. * * **Upcoming Change on 2023-10-01 UTC** * **Description:** `path` will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply instead * **Reason:** We are deprecating the addPullRequestReviewComment mutation */ path?: InputMaybe<Scalars['String']['input']>; /** * The line index in the diff to comment on. * * **Upcoming Change on 2023-10-01 UTC** * **Description:** `position` will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply instead * **Reason:** We are deprecating the addPullRequestReviewComment mutation */ position?: InputMaybe<Scalars['Int']['input']>; /** * The node ID of the pull request reviewing * * **Upcoming Change on 2023-10-01 UTC** * **Description:** `pullRequestId` will be removed. use * addPullRequestReviewThread or addPullRequestReviewThreadReply instead * **Reason:** We are deprecating the addPullRequestReviewComment mutation */ pullRequestId?: InputMaybe<Scalars['ID']['input']>; /** * The Node ID of the review to modify. * * **Upcoming Change on 2023-10-01 UTC** * **Description:** `pullRequestReviewId` will be removed. use * addPullRequestReviewThread or addPullRequestReviewThreadReply instead * **Reason:** We are deprecating the addPullRequestReviewComment mutation */ pullRequestReviewId?: InputMaybe<Scalars['ID']['input']>; }; /** Autogenerated return type of AddPullRequestReviewComment. */ export type AddPullRequestReviewCommentPayload = { __typename?: 'AddPullRequestReviewCommentPayload'; /** A unique identifier for the client performing the mutation. */ clientMutationId?: Maybe<Scalars['String']['output']>; /** The newly created comment. */ comment?: Maybe<PullRequestReviewComment>; /** The edge from the review's comment connection. */ commentEdge?: Maybe<PullRequestReviewCommentEdge>; }; /** Autogenerated input type of AddPullRequestReview */ export type AddPullRequestReviewInput = { /** The contents of the review body comment. */ body?: InputMaybe<Scalars['String']['input']>; /** A unique identifier for the client performing the mutation. */ clientMutationId?: InputMaybe<Scalars['String']['input']>; /** * The review line comments. * * **Upcoming Change on 2023-10-01 UTC** * **Description:** `comments` will be removed. use the `threads` argument instead * **Reason:** We are deprecating comment fields that use diff-relative positioning */ comments?: InputMaybe<Array<InputMaybe<DraftPullRequestReviewComment>>>; /** The commit OID the review pertains to. */ commitOID?: InputMaybe<Scalars['GitObjectID']['input']>; /** The event to perform on the pull request review. */ event?: InputMaybe<PullRequestReviewEvent>; /** The Node ID of the pull request to modify. */ pullRequestId: Scalars['ID']['input']; /** The review line comment threads. */ threads?: InputMaybe<Array<InputMaybe<DraftPullRequestReviewThread>>>; }; /** Autogenerated return type of AddPullRequestReview. */ export type AddPullRequestReviewPayload = { __typename?: 'AddPullRequestReviewPayload'; /** A unique identifier for the client performing the mutation. */ clientMutationId?: Maybe<Scalars['String']['output']>; /** The newly created pull request review. */ pullRequestReview?: Maybe<PullRequestReview>; /** The edge from the pull request's review connection. */ reviewEdge?: Maybe<PullRequestReviewEdge>; }; /** Autogenerated input type of AddPullRequestReviewThread */ export type AddPullRequestReviewThreadInput = { /** Body of the thread's first comment. */ body: Scalars['String']['input']; /** A unique identifier for the client performing the mutation. */ clientMutationId?: InputMaybe<Scalars['String']['input']>; /** * The line of the blob to which the thread refers, required for line-level * threads. The end of the line range for multi-line comments. */ line?: InputMaybe<Scalars['Int']['input']>; /** Path to the file being commented on. */ path: Scalars['String']['input']; /** The node ID of the pull request reviewing */ pullRequestId?: InputMaybe<Scalars['ID']['input']>; /** The Node ID of the review to modify. */ pullRequestReviewId?: InputMaybe<Scalars['ID']['input']>; /** The side of the diff on which the line resides. For multi-line comments, this is the side for the end of the line range. */ side?: InputMaybe<DiffSide>; /** The first line of the range to which the comment refers. */ startLine?: InputMaybe<Scalars['Int']['input']>; /** The side of the diff on which the start line resides. */ startSide?: InputMaybe<DiffSide>; /** The level at which the comments in the corresponding thread are targeted, can be a diff line or a file */ subjectType?: InputMaybe<PullRequestReviewThreadSubjectType>; }; /** Autogenerated return type of AddPullRequestReviewThread. */ export type AddPullRequestReviewThreadPayload = { __typename?: 'AddPullRequestReviewThreadPayload'; /** A unique identifier for the client performing the mutation. */ clientMutationId?: Maybe<Scalars['String']['output']>; /** The newly created thread. */ thread?: Maybe<PullRequestReviewThread>; }; /** Autogenerated input type of AddPullRequestReviewThreadReply */ export type AddPullRequestReviewThreadReplyInput = { /** The text of the reply. */ body: Scalars['String']['input']; /** A unique identifier for the client performing the mutation. */ clientMutationId?: InputMaybe<Scalars['String']['input']>; /** The Node ID of the pending review to which the reply will belong. */ pullRequestReviewId?: InputMaybe<Scalars['ID']['input']>; /** The Node ID of the thread to which this reply is being written. */ pullRequestReviewThreadId: Scalars['ID']['input']; }; /** Autogenerated return type of AddPullRequestReviewThreadReply. */ export type AddPullRequestReviewThreadReplyPayload = { __typename?: 'AddPullRequestReviewThreadReplyPayload'; /** A unique identifier for the client performing the mutation. */ clientMutationId?: Maybe<Scalars['String']['output']>; /** The newly created reply. */ comment?: Maybe<PullRequestReviewComment>; }; /** Autogenerated input type of AddReaction */ export type AddReactionInput = { /** A unique identifier for the client performing the mutation. */ clientMutationId?: InputMaybe<Scalars['String']['input']>; /** The name of the emoji to react with. */ content: ReactionContent; /** The Node ID of the subject to modify. */ subjectId: Scalars['ID']['input']; }; /** Autogenerated return type of AddReaction. */ export type AddReactionPayload = { __typename?: 'AddReactionPayload'; /** A unique identifier for the client performing the mutation. */ clientMutationId?: Maybe<Scalars['String']['output']>; /** The reaction object. */ reaction?: Maybe<Reaction>; /** The reaction groups for the subject. */ reactionGroups?: Maybe<Array<ReactionGroup>>; /** The reactable subject. */ subject?: Maybe<CommitComment | Discussion | DiscussionComment | Issue | IssueComment | PullRequest | PullRequestReview | PullRequestReviewComment | Release | TeamDiscussion | TeamDiscussionComment>; }; /** Autogenerated input type of AddStar */ export type AddStarInput = { /** A unique identifier for the client performing the mutation. */ clientMutationId?: InputMaybe<Scalars['String']['input']>; /** The Starrable ID to star. */ starrableId: Scalars['ID']['input']; }; /** Autogenerated return type of AddStar. */ export type AddStarPayload = { __typename?: 'AddStarPayload'; /** A unique identifier for the client performing the mutation. */ clientMutationId?: Maybe<Scalars['String']['output']>; /** The starrable. */ starrable?: Maybe<Gist | Repository | Topic>; }; /** Autogenerated input type of AddUpvote */ export type AddUpvoteInput = { /** A unique identifier for the client performing the mutation. */ clientMutationId?: InputMaybe<Scalars['String']['input']>; /** The Node ID of the discussion or comment to upvote. */ subjectId: Scalars['ID']['input']; }; /** Autogenerated return type of AddUpvote. */ export type AddUpvotePayload = { __typename?: 'AddUpvotePayload'; /** A unique identifier for the client performing the mutation. */ clientMutationId?: Maybe<Scalars['String']['output']>; /** The votable subject. */ subject?: Maybe<Discussion | DiscussionComment>; }; /** Autogenerated input type of AddVerifiableDomain */ export type AddVerifiableDomainInput = { /** A unique identifier for the client performing the mutation. */ clientMutationId?: InputMaybe<Scalars['String']['input']>; /** The URL of the domain */ domain: Scalars['URI']['input']; /** The ID of the owner to add the domain to */ ownerId: Scalars['ID']['input']; }; /** Autogenerated return type of AddVerifiableDomain. */ export type AddVerifiableDomainPayload = { __typename?: 'AddVerifiableDomainPayload'; /** A unique identifier for the client performing the mutation. */ clientMutationId?: Maybe<Scalars['String']['output']>; /** The verifiable domain that was added. */ domain?: Maybe<VerifiableDomain>; }; /** Represents an 'added_to_merge_queue' event on a given pull request. */ export type AddedToMergeQueueEvent = Node & { __typename?: 'AddedToMergeQueueEvent'; /** Identifies the actor who performed the event. */ actor?: Maybe<Bot | EnterpriseUserAccount | Mannequin | Organization | User>; /** Identifies the date and time when the object was created. */ createdAt: Scalars['DateTime']['output']; /** The user who added this Pull Request to the merge queue */ enqueuer?: Maybe<User>; /** The Node ID of the AddedToMergeQueueEvent object */ id: Scalars['ID']['output']; /** The merge queue where this pull request was added to. */ mergeQueue?: Maybe<MergeQueue>; /** PullRequest referenced by event. */ pullRequest?: Maybe<PullRequest>; }; /** Represents a 'added_to_project' event on a given issue or pull request. */ export type AddedToProjectEvent = Node & { __typename?: 'AddedToProjectEvent'; /** Identifies the actor who performed the event. */ actor?: Maybe<Bot | EnterpriseUserAccount | Mannequin | Organization | User>; /** Identifies the date and time when the object was created. */ createdAt: Scalars['DateTime']['output']; /** Identifies the primary key from the database. */ databaseId?: Maybe<Scalars['Int']['output']>; /** The Node ID of the AddedToProjectEvent object */ id: Scalars['ID']['output']; /** Project referenced by event. */ project?: Maybe<Project>; /** Project card referenced by this project event. */ projectCard?: Maybe<ProjectCard>; /** Column name referenced by this project event. */ projectColumnName: Scalars['String']['output']; }; /** Represents an announcement banner. */ export type AnnouncementBanner = { /** The text of the announcement */ announcement?: Maybe<Scalars['String']['output']>; /** The date the announcement was created */ announcementCreatedAt?: Maybe<Scalars['DateTime']['output']>; /** The expiration date of the announcement, if any */ announcementExpiresAt?: Maybe<Scalars['DateTime']['output']>; /** Whether the announcement can be dismissed by the user */ announcementUserDismissible?: Maybe<Scalars['Boolean']['output']>; }; /** A GitHub App. */ export type App = Node & { __typename?: 'App'; /** Identifies the date and time when the object was created. */ createdAt: Scalars['DateTime']['output']; /** Identifies the primary key from the database. */ databaseId?: Maybe<Scalars['Int']['output']>; /** The description of the app. */ description?: Maybe<Scalars['String']['output']>; /** The Node ID of the App object */ id: Scalars['ID']['output']; /** The IP addresses of the app. */ ipAllowListEntries: IpAllowListEntryConnection; /** The hex color code, without the leading '#', for the logo background. */ logoBackgroundColor: Scalars['String']['output']; /** A URL pointing to the app's logo. */ logoUrl: Scalars['URI']['output']; /** The name of the app. */ name: Scalars['String']['output']; /** A slug based on the name of the app for use in URLs. */ slug: Scalars['String']['output']; /** Identifies the date and time when the object was last updated. */ updatedAt: Scalars['DateTime']['output']; /** The URL to the app's homepage. */ url: Scalars['URI']['output']; }; /** A GitHub App. */ export type AppIpAllowListEntriesArgs = { after?: InputMaybe<Scalars['String']['input']>; before?: InputMaybe<Scalars['String']['input']>; first?: InputMaybe<Scalars['Int']['input']>; last?: InputMaybe<Scalars['Int']['input']>; orderBy?: InputMaybe<IpAllowListEntryOrder>; }; /** A GitHub App. */ export type AppLogoUrlArgs = { size?: InputMaybe<Scalars['Int']['input']>; }; /** Autogenerated input type of ApproveDeployments */ export type ApproveDeploymentsInput = { /** A unique identifier for the client performing the mutation. */ clientMutationId?: InputMaybe<Scalars['String']['input']>; /** Optional comment for approving deployments */ comment?: InputMaybe<Scalars['String']['input']>; /** The ids of environments to reject deployments */ environmentIds: Array<Scalars['ID']['input']>; /** The node ID of the workflow run containing the pending deployments. */ workflowRunId: Scalars['ID']['input']; }; /** Autogenerated return type of ApproveDeployments. */ export type ApproveDeploymentsPayload = { __typename?: 'ApproveDeploymentsPayload'; /** A unique identifier for the client performing the mutation. */ clientMutationId?: Maybe<Scalars['String']['output']>; /** The affected deployments. */ deployments?: Maybe<Array<Deployment>>; }; /** Autogenerated input type of ApproveVerifiableDomain */ export type ApproveVerifiableDomainInput = { /** A unique identifier for the client performing the mutation. */ clientMutationId?: InputMaybe<Scalars['String']['input']>; /** The ID of the verifiable domain to approve. */ id: Scalars['ID']['input']; }; /** Autogenerated return type of ApproveVerifiableDomain. */ export type ApproveVerifiableDomainPayload = { __typename?: 'ApproveVerifiableDomainPayload'; /** A unique identifier for the client performing the mutation. */ clientMutationId?: Maybe<Scalars['String']['output']>; /** The verifiable domain that was approved. */ domain?: Maybe<VerifiableDomain>; }; /** Autogenerated input type of ArchiveProjectV2Item */ export type ArchiveProjectV2ItemInput = { /** A unique identifier for the client performing the mutation. */ clientMutationId?: InputMaybe<Scalars['String']['input']>; /** The ID of the ProjectV2Item to archive. */ itemId: Scalars['ID']['input']; /** The ID of the Project to archive the item from. */ projectId: Scalars['ID']['input']; }; /** Autogenerated return type of ArchiveProjectV2Item. */ export type ArchiveProjectV2ItemPayload = { __typename?: 'ArchiveProjectV2ItemPayload'; /** A unique identifier for the client performing the mutation. */ clientMutationId?: Maybe<Scalars['String']['output']>; /** The item archived from the project. */ item?: Maybe<ProjectV2Item>; }; /** Autogenerated input type of ArchiveRepository */ export type ArchiveRepositoryInput = { /** A unique identifier for the client performing the mutation. */ clientMutationId?: InputMaybe<Scalars['String']['input']>; /** The ID of the repository to mark as archived. */ repositoryId: Scalars['ID']['input']; }; /** Autogenerated return type of ArchiveRepository. */ export type ArchiveRepositoryPayload = { __typename?: 'ArchiveRepositoryPayload'; /** A unique identifier for the client performing the mutation. */ clientMutationId?: Maybe<Scalars['String']['output']>; /** The repository that was marked as archived. */ repository?: Maybe<Repository>; }; /** An object that can have users assigned to it. */ export type Assignable = { /** A list of Users assigned to this object. */ assignees: UserConnection; }; /** An object that can have users assigned to it. */ export type AssignableAssigneesArgs = { after?: InputMaybe<Scalars['String']['input']>; before?: InputMaybe<Scalars['String']['input']>; first?: InputMaybe<Scalars['Int']['input']>; last?: InputMaybe<Scalars['Int']['input']>; }; /** Represents an 'assigned' event on any assignable object. */ export type AssignedEvent = Node & { __typename?: 'AssignedEvent'; /** Identifies the actor who performed the event. */ actor?: Maybe<Bot | EnterpriseUserAccount | Mannequin | Organization | User>; /** Identifies the assignable associated with the event. */ assignable: Issue | PullRequest; /** Identifies the user or mannequin that was assigned. */ assignee?: Maybe<Assignee>; /** Identifies the date and time when the object was created. */ createdAt: Scalars['DateTime']['output']; /** The Node ID of the AssignedEvent object */ id: Scalars['ID']['output']; /** * Identifies the user who was assigned. * @deprecated Assignees can now be mannequins. Use the `assignee` field instead. Removal on 2020-01-01 UTC. */ user?: Maybe<User>; }; /** Types that can be assigned to issues. */ export type Assignee = Bot | Mannequin | Organization | User; /** An entry in the audit log. */ export type AuditEntry = { /** The action name */ action: Scalars['String']['output']; /** The user who initiated the action */ actor?: Maybe<AuditEntryActor>; /** The IP address of the actor */ actorIp?: Maybe<Scalars['String']['output']>; /** A readable representation of the actor's location */ actorLocation?: Maybe<ActorLocation>; /** The username of the user who initiated the action */ actorLogin?: Maybe<Scalars['String']['output']>; /** The HTTP path for the actor. */ actorResourcePath?: Maybe<Scalars['URI']['output']>; /** The HTTP URL for the actor. */ actorUrl?: Maybe<Scalars['URI']['output']>; /** The time the action was initiated */ createdAt: Scalars['PreciseDateTime']['output']; /** The corresponding operation type for the action */ operationType?: Maybe<OperationType>; /** The user affected by the action */ user?: Maybe<User>; /** For actions involving two users, the actor is the initiator and the user is the affected user. */ userLogin?: Maybe<Scalars['String']['output']>; /** The HTTP path for the user. */ userResourcePath?: Maybe<Scalars['URI']['output']>; /** The HTTP URL for the user. */ userUrl?: Maybe<Scalars['URI']['output']>; }; /** Types that can initiate an audit log event. */ export type AuditEntryActor = Bot | Organization | User; /** Ordering options for Audit Log connections. */ export type AuditLogOrder = { /** The ordering direction. */ direction?: InputMaybe<OrderDirection>; /** The field to order Audit Logs by. */ field?: InputMaybe<AuditLogOrderField>; }; /** Properties by which Audit Log connections can be ordered. */ export type AuditLogOrderField = /** Order audit log entries by timestamp */ | 'CREATED_AT'; /** Represents a 'auto_merge_disabled' event on a given pull request. */ export type AutoMergeDisabledEvent = Node & { __typename?: 'AutoMergeDisabledEvent'; /** Identifies the actor who performed the event. */ actor?: Maybe<Bot | EnterpriseUserAccount | Mannequin | Organization | User>; /** Identifies the date and time when the object was created. */ createdAt: Scalars['DateTime']['output']; /** The user who disabled auto-merge for this Pull Request */ disabler?: Maybe<User>; /** The Node ID of the AutoMergeDisabledEvent object */ id: Scalars['ID']['output']; /** PullRequest referenced by event */ pullRequest?: Maybe<PullRequest>; /** The reason auto-merge was disabled */ reason?: Maybe<Scalars['String']['output']>; /** The reason_code relating to why auto-merge was disabled */ reasonCode?: Maybe<Scalars['String']['output']>; }; /** Represents a 'auto_merge_enabled' event on a given pull request. */ export type AutoMergeEnabledEvent = Node & { __typename?: 'AutoMergeEnabledEvent'; /** Identifies the actor who performed the event. */ actor?: Maybe<Bot | EnterpriseUserAccount | Mannequin | Organization | User>; /** Identifies the date and time when the object was created. */ createdAt: Scalars['DateTime']['output']; /** The user who enabled auto-merge for this Pull Request */ enabler?: Maybe<User>; /** The Node ID of the AutoMergeEnabledEvent object */ id: Scalars['ID']['output']; /** PullRequest referenced by event. */ pullRequest?: Maybe<PullRequest>; }; /** Represents an auto-merge request for a pull request */ export type AutoMergeRequest = { __typename?: 'AutoMergeRequest'; /** The email address of the author of this auto-merge request. */ authorEmail?: Maybe<Scalars['String']['output']>; /** * The commit message of the auto-merge request. If a merge queue is required by * the base branch, this value will be set by the merge queue when merging. */ commitBody?: Maybe<Scalars['String']['output']>; /** * The commit title of the auto-merge request. If a merge queue is required by * the base branch, this value will be set by the merge queue when merging */ commitHeadline?: Maybe<Scalars['String']['output']>; /** When was this auto-merge request was enabled. */ enabledAt?: Maybe<Scalars['DateTime']['output']>; /** The actor who created the auto-merge request. */ enabledBy?: Maybe<Bot | EnterpriseUserAccount | Mannequin | Organization | User>; /** * The merge method of the auto-merge request. If a merge queue is required by * the base branch, this value will be set by the merge queue when merging. */ mergeMethod: PullRequestMergeMethod; /** The pull request that this auto-merge request is set against. */ pullRequest: PullRequest; }; /** Represents a 'auto_rebase_enabled' event on a given pull request. */ export type AutoRebaseEnabledEvent = Node & { __typename?: 'AutoRebaseEnabledEvent'; /** Identifies the actor who performed the event. */ actor?: Maybe<Bot | EnterpriseUserAccount | Mannequin | Organization | User>; /** Identifies the date and time when the object was created. */ createdAt: Scalars['DateTime']['output']; /** The user who enabled auto-merge (rebase) for this Pull Request */ enabler?: Maybe<User>; /** The Node ID of the AutoRebaseEnabledEvent object */ id: Scalars['ID']['output']; /** PullRequest referenced by event. */ pullRequest?: Maybe<PullRequest>; }; /** Represents a 'auto_squash_enabled' event on a given pull request. */ export type AutoSquashEnabledEvent = Node & { __typename?: 'AutoSquashEnabledEvent'; /** Identifies the actor who performed the event. */ actor?: Maybe<Bot | EnterpriseUserAccount | Mannequin | Organization | User>; /** Identifies the date and time when the object was created. */ createdAt: Scalars['DateTime']['output']; /** The user who enabled auto-merge (squash) for this Pull Request */ enabler?: Maybe<User>; /** The Node ID of the AutoSquashEnabledEvent object */ id: Scalars['ID']['output']; /** PullRequest referenced by event. */ pullRequest?: Maybe<PullRequest>; }; /** Represents a 'automatic_base_change_failed' event on a given pull request. */ export type AutomaticBaseChangeFailedEvent = Node & { __typename?: 'AutomaticBaseChangeFailedEvent'; /** Identifies the actor who performed the event. */ actor?: Maybe<Bot | EnterpriseUserAccount | Mannequin | Organization | User>; /** Identifies the date and time when the object was created. */ createdAt: Scalars['DateTime']['output']; /** The Node ID of the AutomaticBaseChangeFailedEvent object */ id: Scalars['ID']['output']; /** The new base for this PR */ newBase: Scalars['String']['output']; /** The old base for this PR */ oldBase: Scalars['String']['output']; /** PullRequest referenced by event. */ pullRequest: PullRequest; }; /** Represents a 'automatic_base_change_succeeded' event on a given pull request. */ export type AutomaticBaseChangeSucceededEvent = Node & { __typename?: 'AutomaticBaseChangeSucceededEvent'; /** Identifies the actor who performed the event. */ actor?: Maybe<Bot | EnterpriseUserAccount | Mannequin | Organization | User>; /** Identifies the date and time when the object was created. */ createdAt: Scalars['DateTime']['output']; /** The Node ID of the AutomaticBaseChangeSucceededEvent object */ id: Scalars['ID']['output']; /** The new base for this PR */ newBase: Scalars['String']['output']; /** The old base for this PR */ oldBase: Scalars['String']['output']; /** PullRequest referenced by event. */ pullRequest: PullRequest; }; /** Represents a 'base_ref_changed' event on a given issue or pull request. */ export type BaseRefChangedEvent = Node & { __typename?: 'BaseRefChangedEvent'; /** Identifies the actor who performed the event. */ actor?: Maybe<Bot | EnterpriseUserAccount | Mannequin | Organization | User>; /** Identifies the date and time when the object was created. */ createdAt: Scalars['DateTime']['output']; /** Identifies the name of the base ref for the pull request after it was changed. */ currentRefName: Scalars['String']['output']; /** Identifies the primary key from the database. */ databaseId?: Maybe<Scalars['Int']['output']>; /** The Node ID of the BaseRefChangedEvent object */ id: Scalars['ID']['output']; /** Identifies the name of the base ref for the pull request before it was changed. */ previousRefName: Scalars['Str