AbortQueuedMigrationsInput is an autogenerated input type of AbortQueuedMigrations.
type AbortQueuedMigrationsInput struct {
// The ID of the organization that is running the migrations. (Required.)
OwnerID ID `json:"ownerId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
AbortRepositoryMigrationInput is an autogenerated input type of AbortRepositoryMigration.
type AbortRepositoryMigrationInput struct {
// The ID of the migration to be aborted. (Required.)
MigrationID ID `json:"migrationId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
AcceptEnterpriseAdministratorInvitationInput is an autogenerated input type of AcceptEnterpriseAdministratorInvitation.
type AcceptEnterpriseAdministratorInvitationInput struct {
// The id of the invitation being accepted. (Required.)
InvitationID ID `json:"invitationId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
AcceptEnterpriseMemberInvitationInput is an autogenerated input type of AcceptEnterpriseMemberInvitation.
type AcceptEnterpriseMemberInvitationInput struct {
// The id of the invitation being accepted. (Required.)
InvitationID ID `json:"invitationId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
AcceptTopicSuggestionInput is an autogenerated input type of AcceptTopicSuggestion.
type AcceptTopicSuggestionInput struct {
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
// 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. (Optional.)
RepositoryID *ID `json:"repositoryId,omitempty"`
// 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. (Optional.)
Name *String `json:"name,omitempty"`
}
ActorType represents the actor's type.
type ActorType string
The actor's type.
const (
ActorTypeUser ActorType = "USER" // Indicates a user actor.
ActorTypeTeam ActorType = "TEAM" // Indicates a team actor.
)
AddAssigneesToAssignableInput is an autogenerated input type of AddAssigneesToAssignable.
type AddAssigneesToAssignableInput struct {
// The id of the assignable object to add assignees to. (Required.)
AssignableID ID `json:"assignableId"`
// The id of users to add as assignees. (Required.)
AssigneeIDs []ID `json:"assigneeIds"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
AddCommentInput is an autogenerated input type of AddComment.
type AddCommentInput struct {
// The Node ID of the subject to modify. (Required.)
SubjectID ID `json:"subjectId"`
// The contents of the comment. (Required.)
Body String `json:"body"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
AddDiscussionCommentInput is an autogenerated input type of AddDiscussionComment.
type AddDiscussionCommentInput struct {
// The Node ID of the discussion to comment on. (Required.)
DiscussionID ID `json:"discussionId"`
// The contents of the comment. (Required.)
Body String `json:"body"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
// The Node ID of the discussion comment within this discussion to reply to. (Optional.)
ReplyToID *ID `json:"replyToId,omitempty"`
}
AddDiscussionPollVoteInput is an autogenerated input type of AddDiscussionPollVote.
type AddDiscussionPollVoteInput struct {
// The Node ID of the discussion poll option to vote for. (Required.)
PollOptionID ID `json:"pollOptionId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
AddEnterpriseOrganizationMemberInput is an autogenerated input type of AddEnterpriseOrganizationMember.
type AddEnterpriseOrganizationMemberInput struct {
// The ID of the enterprise which owns the organization. (Required.)
EnterpriseID ID `json:"enterpriseId"`
// The ID of the organization the users will be added to. (Required.)
OrganizationID ID `json:"organizationId"`
// The IDs of the enterprise members to add. (Required.)
UserIDs []ID `json:"userIds"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
// The role to assign the users in the organization. (Optional.)
Role *OrganizationMemberRole `json:"role,omitempty"`
}
AddEnterpriseSupportEntitlementInput is an autogenerated input type of AddEnterpriseSupportEntitlement.
type AddEnterpriseSupportEntitlementInput struct {
// The ID of the Enterprise which the admin belongs to. (Required.)
EnterpriseID ID `json:"enterpriseId"`
// The login of a member who will receive the support entitlement. (Required.)
Login String `json:"login"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
AddLabelsToLabelableInput is an autogenerated input type of AddLabelsToLabelable.
type AddLabelsToLabelableInput struct {
// The id of the labelable object to add labels to. (Required.)
LabelableID ID `json:"labelableId"`
// The ids of the labels to add. (Required.)
LabelIDs []ID `json:"labelIds"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
AddProjectCardInput is an autogenerated input type of AddProjectCard.
type AddProjectCardInput struct {
// The Node ID of the ProjectColumn. (Required.)
ProjectColumnID ID `json:"projectColumnId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
// The content of the card. Must be a member of the ProjectCardItem union. (Optional.)
ContentID *ID `json:"contentId,omitempty"`
// The note on the card. (Optional.)
Note *String `json:"note,omitempty"`
}
AddProjectColumnInput is an autogenerated input type of AddProjectColumn.
type AddProjectColumnInput struct {
// The Node ID of the project. (Required.)
ProjectID ID `json:"projectId"`
// The name of the column. (Required.)
Name String `json:"name"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
AddProjectV2DraftIssueInput is an autogenerated input type of AddProjectV2DraftIssue.
type AddProjectV2DraftIssueInput struct {
// The ID of the Project to add the draft issue to. (Required.)
ProjectID ID `json:"projectId"`
// 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. (Required.)
Title String `json:"title"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
// The body of the draft issue. (Optional.)
Body *String `json:"body,omitempty"`
// The IDs of the assignees of the draft issue. (Optional.)
AssigneeIDs *[]ID `json:"assigneeIds,omitempty"`
}
AddProjectV2ItemByIdInput is an autogenerated input type of AddProjectV2ItemById.
type AddProjectV2ItemByIdInput struct {
// The ID of the Project to add the item to. (Required.)
ProjectID ID `json:"projectId"`
// The id of the Issue or Pull Request to add. (Required.)
ContentID ID `json:"contentId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
AddPullRequestReviewCommentInput is an autogenerated input type of AddPullRequestReviewComment.
type AddPullRequestReviewCommentInput struct {
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
// 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. (Optional.)
PullRequestID *ID `json:"pullRequestId,omitempty"`
// 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. (Optional.)
PullRequestReviewID *ID `json:"pullRequestReviewId,omitempty"`
// 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. (Optional.)
CommitOID *GitObjectID `json:"commitOID,omitempty"`
// 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. (Optional.)
Body *String `json:"body,omitempty"`
// 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. (Optional.)
Path *String `json:"path,omitempty"`
// 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. (Optional.)
Position *Int `json:"position,omitempty"`
// 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. (Optional.)
InReplyTo *ID `json:"inReplyTo,omitempty"`
}
AddPullRequestReviewInput is an autogenerated input type of AddPullRequestReview.
type AddPullRequestReviewInput struct {
// The Node ID of the pull request to modify. (Required.)
PullRequestID ID `json:"pullRequestId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
// The commit OID the review pertains to. (Optional.)
CommitOID *GitObjectID `json:"commitOID,omitempty"`
// The contents of the review body comment. (Optional.)
Body *String `json:"body,omitempty"`
// The event to perform on the pull request review. (Optional.)
Event *PullRequestReviewEvent `json:"event,omitempty"`
// 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. (Optional.)
Comments *[]*DraftPullRequestReviewComment `json:"comments,omitempty"`
// The review line comment threads. (Optional.)
Threads *[]*DraftPullRequestReviewThread `json:"threads,omitempty"`
}
AddPullRequestReviewThreadInput is an autogenerated input type of AddPullRequestReviewThread.
type AddPullRequestReviewThreadInput struct {
// Path to the file being commented on. (Required.)
Path String `json:"path"`
// Body of the thread's first comment. (Required.)
Body String `json:"body"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
// The node ID of the pull request reviewing. (Optional.)
PullRequestID *ID `json:"pullRequestId,omitempty"`
// The Node ID of the review to modify. (Optional.)
PullRequestReviewID *ID `json:"pullRequestReviewId,omitempty"`
// 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. (Optional.)
Line *Int `json:"line,omitempty"`
// 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. (Optional.)
Side *DiffSide `json:"side,omitempty"`
// The first line of the range to which the comment refers. (Optional.)
StartLine *Int `json:"startLine,omitempty"`
// The side of the diff on which the start line resides. (Optional.)
StartSide *DiffSide `json:"startSide,omitempty"`
// The level at which the comments in the corresponding thread are targeted, can be a diff line or a file. (Optional.)
SubjectType *PullRequestReviewThreadSubjectType `json:"subjectType,omitempty"`
}
AddPullRequestReviewThreadReplyInput is an autogenerated input type of AddPullRequestReviewThreadReply.
type AddPullRequestReviewThreadReplyInput struct {
// The Node ID of the thread to which this reply is being written. (Required.)
PullRequestReviewThreadID ID `json:"pullRequestReviewThreadId"`
// The text of the reply. (Required.)
Body String `json:"body"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
// The Node ID of the pending review to which the reply will belong. (Optional.)
PullRequestReviewID *ID `json:"pullRequestReviewId,omitempty"`
}
AddReactionInput is an autogenerated input type of AddReaction.
type AddReactionInput struct {
// The Node ID of the subject to modify. (Required.)
SubjectID ID `json:"subjectId"`
// The name of the emoji to react with. (Required.)
Content ReactionContent `json:"content"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
AddStarInput is an autogenerated input type of AddStar.
type AddStarInput struct {
// The Starrable ID to star. (Required.)
StarrableID ID `json:"starrableId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
AddUpvoteInput is an autogenerated input type of AddUpvote.
type AddUpvoteInput struct {
// The Node ID of the discussion or comment to upvote. (Required.)
SubjectID ID `json:"subjectId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
AddVerifiableDomainInput is an autogenerated input type of AddVerifiableDomain.
type AddVerifiableDomainInput struct {
// The ID of the owner to add the domain to. (Required.)
OwnerID ID `json:"ownerId"`
// The URL of the domain. (Required.)
Domain URI `json:"domain"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
ApproveDeploymentsInput is an autogenerated input type of ApproveDeployments.
type ApproveDeploymentsInput struct {
// The node ID of the workflow run containing the pending deployments. (Required.)
WorkflowRunID ID `json:"workflowRunId"`
// The ids of environments to reject deployments. (Required.)
EnvironmentIDs []ID `json:"environmentIds"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
// Optional comment for approving deployments. (Optional.)
Comment *String `json:"comment,omitempty"`
}
ApproveVerifiableDomainInput is an autogenerated input type of ApproveVerifiableDomain.
type ApproveVerifiableDomainInput struct {
// The ID of the verifiable domain to approve. (Required.)
ID ID `json:"id"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
ArchiveProjectV2ItemInput is an autogenerated input type of ArchiveProjectV2Item.
type ArchiveProjectV2ItemInput struct {
// The ID of the Project to archive the item from. (Required.)
ProjectID ID `json:"projectId"`
// The ID of the ProjectV2Item to archive. (Required.)
ItemID ID `json:"itemId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
ArchiveRepositoryInput is an autogenerated input type of ArchiveRepository.
type ArchiveRepositoryInput struct {
// The ID of the repository to mark as archived. (Required.)
RepositoryID ID `json:"repositoryId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
AuditLogOrder represents ordering options for Audit Log connections.
type AuditLogOrder struct {
// The field to order Audit Logs by. (Optional.)
Field *AuditLogOrderField `json:"field,omitempty"`
// The ordering direction. (Optional.)
Direction *OrderDirection `json:"direction,omitempty"`
}
AuditLogOrderField represents properties by which Audit Log connections can be ordered.
type AuditLogOrderField string
Properties by which Audit Log connections can be ordered.
const (
AuditLogOrderFieldCreatedAt AuditLogOrderField = "CREATED_AT" // Order audit log entries by timestamp.
)
Base64String is a (potentially binary) string encoded using base64.
type Base64String string
func NewBase64String(v Base64String) *Base64String
NewBase64String is a helper to make a new *Base64String.
Boolean represents true or false values.
type Boolean graphql.Boolean
func NewBoolean(v Boolean) *Boolean
NewBoolean is a helper to make a new *Boolean.
BranchNamePatternParametersInput represents parameters to be used for the branch_name_pattern rule.
type BranchNamePatternParametersInput struct {
// The operator to use for matching. (Required.)
Operator String `json:"operator"`
// The pattern to match with. (Required.)
Pattern String `json:"pattern"`
// How this rule will appear to users. (Optional.)
Name *String `json:"name,omitempty"`
// If true, the rule will fail if the pattern matches. (Optional.)
Negate *Boolean `json:"negate,omitempty"`
}
BulkSponsorship represents information about a sponsorship to make for a user or organization with a GitHub Sponsors profile, as part of sponsoring many users or organizations at once.
type BulkSponsorship struct {
// The amount to pay to the sponsorable in US dollars. Valid values: 1-12000. (Required.)
Amount Int `json:"amount"`
// The ID of the user or organization who is receiving the sponsorship. Required if sponsorableLogin is not given. (Optional.)
SponsorableID *ID `json:"sponsorableId,omitempty"`
// The username of the user or organization who is receiving the sponsorship. Required if sponsorableId is not given. (Optional.)
SponsorableLogin *String `json:"sponsorableLogin,omitempty"`
}
CancelEnterpriseAdminInvitationInput is an autogenerated input type of CancelEnterpriseAdminInvitation.
type CancelEnterpriseAdminInvitationInput struct {
// The Node ID of the pending enterprise administrator invitation. (Required.)
InvitationID ID `json:"invitationId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
CancelEnterpriseMemberInvitationInput is an autogenerated input type of CancelEnterpriseMemberInvitation.
type CancelEnterpriseMemberInvitationInput struct {
// The Node ID of the pending enterprise member invitation. (Required.)
InvitationID ID `json:"invitationId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
CancelSponsorshipInput is an autogenerated input type of CancelSponsorship.
type CancelSponsorshipInput struct {
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
// The ID of the user or organization who is acting as the sponsor, paying for the sponsorship. Required if sponsorLogin is not given. (Optional.)
SponsorID *ID `json:"sponsorId,omitempty"`
// The username of the user or organization who is acting as the sponsor, paying for the sponsorship. Required if sponsorId is not given. (Optional.)
SponsorLogin *String `json:"sponsorLogin,omitempty"`
// The ID of the user or organization who is receiving the sponsorship. Required if sponsorableLogin is not given. (Optional.)
SponsorableID *ID `json:"sponsorableId,omitempty"`
// The username of the user or organization who is receiving the sponsorship. Required if sponsorableId is not given. (Optional.)
SponsorableLogin *String `json:"sponsorableLogin,omitempty"`
}
ChangeUserStatusInput is an autogenerated input type of ChangeUserStatus.
type ChangeUserStatusInput struct {
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
// The emoji to represent your status. Can either be a native Unicode emoji or an emoji name with colons, e.g., :grinning:. (Optional.)
Emoji *String `json:"emoji,omitempty"`
// A short description of your current status. (Optional.)
Message *String `json:"message,omitempty"`
// The ID of the organization whose members will be allowed to see the status. If omitted, the status will be publicly visible. (Optional.)
OrganizationID *ID `json:"organizationId,omitempty"`
// Whether this status should indicate you are not fully available on GitHub, e.g., you are away. (Optional.)
LimitedAvailability *Boolean `json:"limitedAvailability,omitempty"`
// If set, the user status will not be shown after this date. (Optional.)
ExpiresAt *DateTime `json:"expiresAt,omitempty"`
}
CheckAnnotationData represents information from a check run analysis to specific lines of code.
type CheckAnnotationData struct {
// The path of the file to add an annotation to. (Required.)
Path String `json:"path"`
// The location of the annotation. (Required.)
Location CheckAnnotationRange `json:"location"`
// Represents an annotation's information level. (Required.)
AnnotationLevel CheckAnnotationLevel `json:"annotationLevel"`
// A short description of the feedback for these lines of code. (Required.)
Message String `json:"message"`
// The title that represents the annotation. (Optional.)
Title *String `json:"title,omitempty"`
// Details about this annotation. (Optional.)
RawDetails *String `json:"rawDetails,omitempty"`
}
CheckAnnotationLevel represents represents an annotation's information level.
type CheckAnnotationLevel string
Represents an annotation's information level.
const (
CheckAnnotationLevelFailure CheckAnnotationLevel = "FAILURE" // An annotation indicating an inescapable error.
CheckAnnotationLevelNotice CheckAnnotationLevel = "NOTICE" // An annotation indicating some information.
CheckAnnotationLevelWarning CheckAnnotationLevel = "WARNING" // An annotation indicating an ignorable error.
)
CheckAnnotationRange represents information from a check run analysis to specific lines of code.
type CheckAnnotationRange struct {
// The starting line of the range. (Required.)
StartLine Int `json:"startLine"`
// The ending line of the range. (Required.)
EndLine Int `json:"endLine"`
// The starting column of the range. (Optional.)
StartColumn *Int `json:"startColumn,omitempty"`
// The ending column of the range. (Optional.)
EndColumn *Int `json:"endColumn,omitempty"`
}
CheckConclusionState represents the possible states for a check suite or run conclusion.
type CheckConclusionState string
The possible states for a check suite or run conclusion.
const (
CheckConclusionStateActionRequired CheckConclusionState = "ACTION_REQUIRED" // The check suite or run requires action.
CheckConclusionStateTimedOut CheckConclusionState = "TIMED_OUT" // The check suite or run has timed out.
CheckConclusionStateCancelled CheckConclusionState = "CANCELLED" // The check suite or run has been cancelled.
CheckConclusionStateFailure CheckConclusionState = "FAILURE" // The check suite or run has failed.
CheckConclusionStateSuccess CheckConclusionState = "SUCCESS" // The check suite or run has succeeded.
CheckConclusionStateNeutral CheckConclusionState = "NEUTRAL" // The check suite or run was neutral.
CheckConclusionStateSkipped CheckConclusionState = "SKIPPED" // The check suite or run was skipped.
CheckConclusionStateStartupFailure CheckConclusionState = "STARTUP_FAILURE" // The check suite or run has failed at startup.
CheckConclusionStateStale CheckConclusionState = "STALE" // The check suite or run was marked stale by GitHub. Only GitHub can use this conclusion.
)
CheckRunAction represents possible further actions the integrator can perform.
type CheckRunAction struct {
// The text to be displayed on a button in the web UI. (Required.)
Label String `json:"label"`
// A short explanation of what this action would do. (Required.)
Description String `json:"description"`
// A reference for the action on the integrator's system. (Required.)
Identifier String `json:"identifier"`
}
CheckRunFilter represents the filters that are available when fetching check runs.
type CheckRunFilter struct {
// Filters the check runs by this type. (Optional.)
CheckType *CheckRunType `json:"checkType,omitempty"`
// Filters the check runs created by this application ID. (Optional.)
AppID *Int `json:"appId,omitempty"`
// Filters the check runs by this name. (Optional.)
CheckName *String `json:"checkName,omitempty"`
// Filters the check runs by this status. Superceded by statuses. (Optional.)
Status *CheckStatusState `json:"status,omitempty"`
// Filters the check runs by this status. Overrides status. (Optional.)
Statuses *[]CheckStatusState `json:"statuses,omitempty"`
// Filters the check runs by these conclusions. (Optional.)
Conclusions *[]CheckConclusionState `json:"conclusions,omitempty"`
}
CheckRunOutput represents descriptive details about the check run.
type CheckRunOutput struct {
// A title to provide for this check run. (Required.)
Title String `json:"title"`
// The summary of the check run (supports Commonmark). (Required.)
Summary String `json:"summary"`
// The details of the check run (supports Commonmark). (Optional.)
Text *String `json:"text,omitempty"`
// The annotations that are made as part of the check run. (Optional.)
Annotations *[]CheckAnnotationData `json:"annotations,omitempty"`
// Images attached to the check run output displayed in the GitHub pull request UI. (Optional.)
Images *[]CheckRunOutputImage `json:"images,omitempty"`
}
CheckRunOutputImage represents images attached to the check run output displayed in the GitHub pull request UI.
type CheckRunOutputImage struct {
// The alternative text for the image. (Required.)
Alt String `json:"alt"`
// The full URL of the image. (Required.)
ImageURL URI `json:"imageUrl"`
// A short image description. (Optional.)
Caption *String `json:"caption,omitempty"`
}
CheckRunState represents the possible states of a check run in a status rollup.
type CheckRunState string
The possible states of a check run in a status rollup.
const (
CheckRunStateActionRequired CheckRunState = "ACTION_REQUIRED" // The check run requires action.
CheckRunStateCancelled CheckRunState = "CANCELLED" // The check run has been cancelled.
CheckRunStateCompleted CheckRunState = "COMPLETED" // The check run has been completed.
CheckRunStateFailure CheckRunState = "FAILURE" // The check run has failed.
CheckRunStateInProgress CheckRunState = "IN_PROGRESS" // The check run is in progress.
CheckRunStateNeutral CheckRunState = "NEUTRAL" // The check run was neutral.
CheckRunStatePending CheckRunState = "PENDING" // The check run is in pending state.
CheckRunStateQueued CheckRunState = "QUEUED" // The check run has been queued.
CheckRunStateSkipped CheckRunState = "SKIPPED" // The check run was skipped.
CheckRunStateStale CheckRunState = "STALE" // The check run was marked stale by GitHub. Only GitHub can use this conclusion.
CheckRunStateStartupFailure CheckRunState = "STARTUP_FAILURE" // The check run has failed at startup.
CheckRunStateSuccess CheckRunState = "SUCCESS" // The check run has succeeded.
CheckRunStateTimedOut CheckRunState = "TIMED_OUT" // The check run has timed out.
CheckRunStateWaiting CheckRunState = "WAITING" // The check run is in waiting state.
)
CheckRunType represents the possible types of check runs.
type CheckRunType string
The possible types of check runs.
const (
CheckRunTypeAll CheckRunType = "ALL" // Every check run available.
CheckRunTypeLatest CheckRunType = "LATEST" // The latest check run.
)
CheckStatusState represents the possible states for a check suite or run status.
type CheckStatusState string
The possible states for a check suite or run status.
const (
CheckStatusStateRequested CheckStatusState = "REQUESTED" // The check suite or run has been requested.
CheckStatusStateQueued CheckStatusState = "QUEUED" // The check suite or run has been queued.
CheckStatusStateInProgress CheckStatusState = "IN_PROGRESS" // The check suite or run is in progress.
CheckStatusStateCompleted CheckStatusState = "COMPLETED" // The check suite or run has been completed.
CheckStatusStateWaiting CheckStatusState = "WAITING" // The check suite or run is in waiting state.
CheckStatusStatePending CheckStatusState = "PENDING" // The check suite or run is in pending state.
)
CheckSuiteAutoTriggerPreference represents the auto-trigger preferences that are available for check suites.
type CheckSuiteAutoTriggerPreference struct {
// The node ID of the application that owns the check suite. (Required.)
AppID ID `json:"appId"`
// Set to `true` to enable automatic creation of CheckSuite events upon pushes to the repository. (Required.)
Setting Boolean `json:"setting"`
}
CheckSuiteFilter represents the filters that are available when fetching check suites.
type CheckSuiteFilter struct {
// Filters the check suites created by this application ID. (Optional.)
AppID *Int `json:"appId,omitempty"`
// Filters the check suites by this name. (Optional.)
CheckName *String `json:"checkName,omitempty"`
}
ClearLabelsFromLabelableInput is an autogenerated input type of ClearLabelsFromLabelable.
type ClearLabelsFromLabelableInput struct {
// The id of the labelable object to clear the labels from. (Required.)
LabelableID ID `json:"labelableId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
ClearProjectV2ItemFieldValueInput is an autogenerated input type of ClearProjectV2ItemFieldValue.
type ClearProjectV2ItemFieldValueInput struct {
// The ID of the Project. (Required.)
ProjectID ID `json:"projectId"`
// The ID of the item to be cleared. (Required.)
ItemID ID `json:"itemId"`
// The ID of the field to be cleared. (Required.)
FieldID ID `json:"fieldId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
Client is a GitHub GraphQL API v4 client.
type Client struct {
// contains filtered or unexported fields
}
func NewClient(httpClient *http.Client) *Client
NewClient creates a new GitHub GraphQL API v4 client with the provided http.Client. If httpClient is nil, then http.DefaultClient is used.
Note that GitHub GraphQL API v4 requires authentication, so the provided http.Client is expected to take care of that.
func NewEnterpriseClient(url string, httpClient *http.Client) *Client
NewEnterpriseClient creates a new GitHub GraphQL API v4 client for the GitHub Enterprise instance with the specified GraphQL endpoint URL, using the provided http.Client. If httpClient is nil, then http.DefaultClient is used.
Note that GitHub GraphQL API v4 requires authentication, so the provided http.Client is expected to take care of that.
func (c *Client) Mutate(ctx context.Context, m interface{}, input Input, variables map[string]interface{}) error
Mutate executes a single GraphQL mutation request, with a mutation derived from m, populating the response into it. m should be a pointer to struct that corresponds to the GitHub GraphQL schema. Provided input will be set as a variable named "input".
func (c *Client) Query(ctx context.Context, q interface{}, variables map[string]interface{}) error
Query executes a single GraphQL query request, with a query derived from q, populating the response into it. q should be a pointer to struct that corresponds to the GitHub GraphQL schema.
CloneProjectInput is an autogenerated input type of CloneProject.
type CloneProjectInput struct {
// The owner ID to create the project under. (Required.)
TargetOwnerID ID `json:"targetOwnerId"`
// The source project to clone. (Required.)
SourceID ID `json:"sourceId"`
// Whether or not to clone the source project's workflows. (Required.)
IncludeWorkflows Boolean `json:"includeWorkflows"`
// The name of the project. (Required.)
Name String `json:"name"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
// The description of the project. (Optional.)
Body *String `json:"body,omitempty"`
// The visibility of the project, defaults to false (private). (Optional.)
Public *Boolean `json:"public,omitempty"`
}
CloneTemplateRepositoryInput is an autogenerated input type of CloneTemplateRepository.
type CloneTemplateRepositoryInput struct {
// The Node ID of the template repository. (Required.)
RepositoryID ID `json:"repositoryId"`
// The name of the new repository. (Required.)
Name String `json:"name"`
// The ID of the owner for the new repository. (Required.)
OwnerID ID `json:"ownerId"`
// Indicates the repository's visibility level. (Required.)
Visibility RepositoryVisibility `json:"visibility"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
// A short description of the new repository. (Optional.)
Description *String `json:"description,omitempty"`
// Whether to copy all branches from the template to the new repository. Defaults to copying only the default branch of the template. (Optional.)
IncludeAllBranches *Boolean `json:"includeAllBranches,omitempty"`
}
CloseDiscussionInput is an autogenerated input type of CloseDiscussion.
type CloseDiscussionInput struct {
// ID of the discussion to be closed. (Required.)
DiscussionID ID `json:"discussionId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
// The reason why the discussion is being closed. (Optional.)
Reason *DiscussionCloseReason `json:"reason,omitempty"`
}
CloseIssueInput is an autogenerated input type of CloseIssue.
type CloseIssueInput struct {
// ID of the issue to be closed. (Required.)
IssueID ID `json:"issueId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
// The reason the issue is to be closed. (Optional.)
StateReason *IssueClosedStateReason `json:"stateReason,omitempty"`
}
ClosePullRequestInput is an autogenerated input type of ClosePullRequest.
type ClosePullRequestInput struct {
// ID of the pull request to be closed. (Required.)
PullRequestID ID `json:"pullRequestId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
CodeScanningParametersInput represents choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.
type CodeScanningParametersInput struct {
// Tools that must provide code scanning results for this rule to pass. (Required.)
CodeScanningTools []CodeScanningToolInput `json:"codeScanningTools"`
}
CodeScanningToolInput represents a tool that must provide code scanning results for this rule to pass.
type CodeScanningToolInput struct {
// The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see "[About code scanning alerts](${externalDocsUrl}/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).". (Required.)
AlertsThreshold String `json:"alertsThreshold"`
// The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see "[About code scanning alerts](${externalDocsUrl}/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).". (Required.)
SecurityAlertsThreshold String `json:"securityAlertsThreshold"`
// The name of a code scanning tool. (Required.)
Tool String `json:"tool"`
}
CollaboratorAffiliation represents collaborators affiliation level with a subject.
type CollaboratorAffiliation string
Collaborators affiliation level with a subject.
const (
CollaboratorAffiliationOutside CollaboratorAffiliation = "OUTSIDE" // All outside collaborators of an organization-owned subject.
CollaboratorAffiliationDirect CollaboratorAffiliation = "DIRECT" // All collaborators with permissions to an organization-owned subject, regardless of organization membership status.
CollaboratorAffiliationAll CollaboratorAffiliation = "ALL" // All collaborators the authenticated user can see.
)
CommentAuthorAssociation represents a comment author association with repository.
type CommentAuthorAssociation string
A comment author association with repository.
const (
CommentAuthorAssociationMember CommentAuthorAssociation = "MEMBER" // Author is a member of the organization that owns the repository.
CommentAuthorAssociationOwner CommentAuthorAssociation = "OWNER" // Author is the owner of the repository.
CommentAuthorAssociationMannequin CommentAuthorAssociation = "MANNEQUIN" // Author is a placeholder for an unclaimed user.
CommentAuthorAssociationCollaborator CommentAuthorAssociation = "COLLABORATOR" // Author has been invited to collaborate on the repository.
CommentAuthorAssociationContributor CommentAuthorAssociation = "CONTRIBUTOR" // Author has previously committed to the repository.
CommentAuthorAssociationFirstTimeContributor CommentAuthorAssociation = "FIRST_TIME_CONTRIBUTOR" // Author has not previously committed to the repository.
CommentAuthorAssociationFirstTimer CommentAuthorAssociation = "FIRST_TIMER" // Author has not previously committed to GitHub.
CommentAuthorAssociationNone CommentAuthorAssociation = "NONE" // Author has no association with the repository.
)
CommentCannotUpdateReason represents the possible errors that will prevent a user from updating a comment.
type CommentCannotUpdateReason string
The possible errors that will prevent a user from updating a comment.
const (
CommentCannotUpdateReasonArchived CommentCannotUpdateReason = "ARCHIVED" // Unable to create comment because repository is archived.
CommentCannotUpdateReasonInsufficientAccess CommentCannotUpdateReason = "INSUFFICIENT_ACCESS" // You must be the author or have write access to this repository to update this comment.
CommentCannotUpdateReasonLocked CommentCannotUpdateReason = "LOCKED" // Unable to create comment because issue is locked.
CommentCannotUpdateReasonLoginRequired CommentCannotUpdateReason = "LOGIN_REQUIRED" // You must be logged in to update this comment.
CommentCannotUpdateReasonMaintenance CommentCannotUpdateReason = "MAINTENANCE" // Repository is under maintenance.
CommentCannotUpdateReasonVerifiedEmailRequired CommentCannotUpdateReason = "VERIFIED_EMAIL_REQUIRED" // At least one email address must be verified to update this comment.
CommentCannotUpdateReasonDenied CommentCannotUpdateReason = "DENIED" // You cannot update this comment.
)
CommitAuthor specifies an author for filtering Git commits.
type CommitAuthor struct {
// ID of a User to filter by. If non-null, only commits authored by this user will be returned. This field takes precedence over emails. (Optional.)
ID *ID `json:"id,omitempty"`
// Email addresses to filter by. Commits authored by any of the specified email addresses will be returned. (Optional.)
Emails *[]String `json:"emails,omitempty"`
}
CommitAuthorEmailPatternParametersInput represents parameters to be used for the commit_author_email_pattern rule.
type CommitAuthorEmailPatternParametersInput struct {
// The operator to use for matching. (Required.)
Operator String `json:"operator"`
// The pattern to match with. (Required.)
Pattern String `json:"pattern"`
// How this rule will appear to users. (Optional.)
Name *String `json:"name,omitempty"`
// If true, the rule will fail if the pattern matches. (Optional.)
Negate *Boolean `json:"negate,omitempty"`
}
CommitContributionOrder represents ordering options for commit contribution connections.
type CommitContributionOrder struct {
// The field by which to order commit contributions. (Required.)
Field CommitContributionOrderField `json:"field"`
// The ordering direction. (Required.)
Direction OrderDirection `json:"direction"`
}
CommitContributionOrderField represents properties by which commit contribution connections can be ordered.
type CommitContributionOrderField string
Properties by which commit contribution connections can be ordered.
const (
CommitContributionOrderFieldOccurredAt CommitContributionOrderField = "OCCURRED_AT" // Order commit contributions by when they were made.
CommitContributionOrderFieldCommitCount CommitContributionOrderField = "COMMIT_COUNT" // Order commit contributions by how many commits they represent.
)
CommitMessage represents a message to include with a new commit.
type CommitMessage struct {
// The headline of the message. (Required.)
Headline String `json:"headline"`
// The body of the message. (Optional.)
Body *String `json:"body,omitempty"`
}
CommitMessagePatternParametersInput represents parameters to be used for the commit_message_pattern rule.
type CommitMessagePatternParametersInput struct {
// The operator to use for matching. (Required.)
Operator String `json:"operator"`
// The pattern to match with. (Required.)
Pattern String `json:"pattern"`
// How this rule will appear to users. (Optional.)
Name *String `json:"name,omitempty"`
// If true, the rule will fail if the pattern matches. (Optional.)
Negate *Boolean `json:"negate,omitempty"`
}
CommittableBranch represents a git ref for a commit to be appended to. The ref must be a branch, i.e. its fully qualified name must start with `refs/heads/` (although the input is not required to be fully qualified). The Ref may be specified by its global node ID or by the `repositoryNameWithOwner` and `branchName`. ### Examples Specify a branch using a global node ID: { "id": "MDM6UmVmMTpyZWZzL2hlYWRzL21haW4=" } Specify a branch using `repositoryNameWithOwner` and `branchName`: { "repositoryNameWithOwner": "github/graphql-client", "branchName": "main" }.
type CommittableBranch struct {
// The Node ID of the Ref to be updated. (Optional.)
ID *ID `json:"id,omitempty"`
// The nameWithOwner of the repository to commit to. (Optional.)
RepositoryNameWithOwner *String `json:"repositoryNameWithOwner,omitempty"`
// The unqualified name of the branch to append the commit to. (Optional.)
BranchName *String `json:"branchName,omitempty"`
}
CommitterEmailPatternParametersInput represents parameters to be used for the committer_email_pattern rule.
type CommitterEmailPatternParametersInput struct {
// The operator to use for matching. (Required.)
Operator String `json:"operator"`
// The pattern to match with. (Required.)
Pattern String `json:"pattern"`
// How this rule will appear to users. (Optional.)
Name *String `json:"name,omitempty"`
// If true, the rule will fail if the pattern matches. (Optional.)
Negate *Boolean `json:"negate,omitempty"`
}
ComparisonStatus represents the status of a git comparison between two refs.
type ComparisonStatus string
The status of a git comparison between two refs.
const (
ComparisonStatusDiverged ComparisonStatus = "DIVERGED" // The head ref is both ahead and behind of the base ref, indicating git history has diverged.
ComparisonStatusAhead ComparisonStatus = "AHEAD" // The head ref is ahead of the base ref.
ComparisonStatusBehind ComparisonStatus = "BEHIND" // The head ref is behind the base ref.
ComparisonStatusIdentical ComparisonStatus = "IDENTICAL" // The head ref and base ref are identical.
)
ContributionLevel represents varying levels of contributions from none to many.
type ContributionLevel string
Varying levels of contributions from none to many.
const (
ContributionLevelNone ContributionLevel = "NONE" // No contributions occurred.
ContributionLevelFirstQuartile ContributionLevel = "FIRST_QUARTILE" // Lowest 25% of days of contributions.
ContributionLevelSecondQuartile ContributionLevel = "SECOND_QUARTILE" // Second lowest 25% of days of contributions. More contributions than the first quartile.
ContributionLevelThirdQuartile ContributionLevel = "THIRD_QUARTILE" // Second highest 25% of days of contributions. More contributions than second quartile, less than the fourth quartile.
ContributionLevelFourthQuartile ContributionLevel = "FOURTH_QUARTILE" // Highest 25% of days of contributions. More contributions than the third quartile.
)
ContributionOrder represents ordering options for contribution connections.
type ContributionOrder struct {
// The ordering direction. (Required.)
Direction OrderDirection `json:"direction"`
}
ConvertProjectCardNoteToIssueInput is an autogenerated input type of ConvertProjectCardNoteToIssue.
type ConvertProjectCardNoteToIssueInput struct {
// The ProjectCard ID to convert. (Required.)
ProjectCardID ID `json:"projectCardId"`
// The ID of the repository to create the issue in. (Required.)
RepositoryID ID `json:"repositoryId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
// The title of the newly created issue. Defaults to the card's note text. (Optional.)
Title *String `json:"title,omitempty"`
// The body of the newly created issue. (Optional.)
Body *String `json:"body,omitempty"`
}
ConvertProjectV2DraftIssueItemToIssueInput is an autogenerated input type of ConvertProjectV2DraftIssueItemToIssue.
type ConvertProjectV2DraftIssueItemToIssueInput struct {
// The ID of the draft issue ProjectV2Item to convert. (Required.)
ItemID ID `json:"itemId"`
// The ID of the repository to create the issue in. (Required.)
RepositoryID ID `json:"repositoryId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
ConvertPullRequestToDraftInput is an autogenerated input type of ConvertPullRequestToDraft.
type ConvertPullRequestToDraftInput struct {
// ID of the pull request to convert to draft. (Required.)
PullRequestID ID `json:"pullRequestId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
CopyProjectV2Input is an autogenerated input type of CopyProjectV2.
type CopyProjectV2Input struct {
// The ID of the source Project to copy. (Required.)
ProjectID ID `json:"projectId"`
// The owner ID of the new project. (Required.)
OwnerID ID `json:"ownerId"`
// The title of the project. (Required.)
Title String `json:"title"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
// Include draft issues in the new project. (Optional.)
IncludeDraftIssues *Boolean `json:"includeDraftIssues,omitempty"`
}
CreateAttributionInvitationInput is an autogenerated input type of CreateAttributionInvitation.
type CreateAttributionInvitationInput struct {
// The Node ID of the owner scoping the reattributable data. (Required.)
OwnerID ID `json:"ownerId"`
// The Node ID of the account owning the data to reattribute. (Required.)
SourceID ID `json:"sourceId"`
// The Node ID of the account which may claim the data. (Required.)
TargetID ID `json:"targetId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
CreateBranchProtectionRuleInput is an autogenerated input type of CreateBranchProtectionRule.
type CreateBranchProtectionRuleInput struct {
// The global relay id of the repository in which a new branch protection rule should be created in. (Required.)
RepositoryID ID `json:"repositoryId"`
// The glob-like pattern used to determine matching branches. (Required.)
Pattern String `json:"pattern"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
// Are approving reviews required to update matching branches. (Optional.)
RequiresApprovingReviews *Boolean `json:"requiresApprovingReviews,omitempty"`
// Number of approving reviews required to update matching branches. (Optional.)
RequiredApprovingReviewCount *Int `json:"requiredApprovingReviewCount,omitempty"`
// Are commits required to be signed. (Optional.)
RequiresCommitSignatures *Boolean `json:"requiresCommitSignatures,omitempty"`
// Are merge commits prohibited from being pushed to this branch. (Optional.)
RequiresLinearHistory *Boolean `json:"requiresLinearHistory,omitempty"`
// Is branch creation a protected operation. (Optional.)
BlocksCreations *Boolean `json:"blocksCreations,omitempty"`
// Are force pushes allowed on this branch. (Optional.)
AllowsForcePushes *Boolean `json:"allowsForcePushes,omitempty"`
// Can this branch be deleted. (Optional.)
AllowsDeletions *Boolean `json:"allowsDeletions,omitempty"`
// Can admins override branch protection. (Optional.)
IsAdminEnforced *Boolean `json:"isAdminEnforced,omitempty"`
// Are status checks required to update matching branches. (Optional.)
RequiresStatusChecks *Boolean `json:"requiresStatusChecks,omitempty"`
// Are branches required to be up to date before merging. (Optional.)
RequiresStrictStatusChecks *Boolean `json:"requiresStrictStatusChecks,omitempty"`
// Are reviews from code owners required to update matching branches. (Optional.)
RequiresCodeOwnerReviews *Boolean `json:"requiresCodeOwnerReviews,omitempty"`
// Will new commits pushed to matching branches dismiss pull request review approvals. (Optional.)
DismissesStaleReviews *Boolean `json:"dismissesStaleReviews,omitempty"`
// Is dismissal of pull request reviews restricted. (Optional.)
RestrictsReviewDismissals *Boolean `json:"restrictsReviewDismissals,omitempty"`
// A list of User, Team, or App IDs allowed to dismiss reviews on pull requests targeting matching branches. (Optional.)
ReviewDismissalActorIDs *[]ID `json:"reviewDismissalActorIds,omitempty"`
// A list of User, Team, or App IDs allowed to bypass pull requests targeting matching branches. (Optional.)
BypassPullRequestActorIDs *[]ID `json:"bypassPullRequestActorIds,omitempty"`
// A list of User, Team, or App IDs allowed to bypass force push targeting matching branches. (Optional.)
BypassForcePushActorIDs *[]ID `json:"bypassForcePushActorIds,omitempty"`
// Is pushing to matching branches restricted. (Optional.)
RestrictsPushes *Boolean `json:"restrictsPushes,omitempty"`
// A list of User, Team, or App IDs allowed to push to matching branches. (Optional.)
PushActorIDs *[]ID `json:"pushActorIds,omitempty"`
// List of required status check contexts that must pass for commits to be accepted to matching branches. (Optional.)
RequiredStatusCheckContexts *[]String `json:"requiredStatusCheckContexts,omitempty"`
// The list of required status checks. (Optional.)
RequiredStatusChecks *[]RequiredStatusCheckInput `json:"requiredStatusChecks,omitempty"`
// Are successful deployments required before merging. (Optional.)
RequiresDeployments *Boolean `json:"requiresDeployments,omitempty"`
// The list of required deployment environments. (Optional.)
RequiredDeploymentEnvironments *[]String `json:"requiredDeploymentEnvironments,omitempty"`
// Are conversations required to be resolved before merging. (Optional.)
RequiresConversationResolution *Boolean `json:"requiresConversationResolution,omitempty"`
// Whether the most recent push must be approved by someone other than the person who pushed it. (Optional.)
RequireLastPushApproval *Boolean `json:"requireLastPushApproval,omitempty"`
// Whether to set the branch as read-only. If this is true, users will not be able to push to the branch. (Optional.)
LockBranch *Boolean `json:"lockBranch,omitempty"`
// Whether users can pull changes from upstream when the branch is locked. Set to `true` to allow fork syncing. Set to `false` to prevent fork syncing. (Optional.)
LockAllowsFetchAndMerge *Boolean `json:"lockAllowsFetchAndMerge,omitempty"`
}
CreateCheckRunInput is an autogenerated input type of CreateCheckRun.
type CreateCheckRunInput struct {
// The node ID of the repository. (Required.)
RepositoryID ID `json:"repositoryId"`
// The name of the check. (Required.)
Name String `json:"name"`
// The SHA of the head commit. (Required.)
HeadSha GitObjectID `json:"headSha"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
// The URL of the integrator's site that has the full details of the check. (Optional.)
DetailsURL *URI `json:"detailsUrl,omitempty"`
// A reference for the run on the integrator's system. (Optional.)
ExternalID *String `json:"externalId,omitempty"`
// The current status. (Optional.)
Status *RequestableCheckStatusState `json:"status,omitempty"`
// The time that the check run began. (Optional.)
StartedAt *DateTime `json:"startedAt,omitempty"`
// The final conclusion of the check. (Optional.)
Conclusion *CheckConclusionState `json:"conclusion,omitempty"`
// The time that the check run finished. (Optional.)
CompletedAt *DateTime `json:"completedAt,omitempty"`
// Descriptive details about the run. (Optional.)
Output *CheckRunOutput `json:"output,omitempty"`
// Possible further actions the integrator can perform, which a user may trigger. (Optional.)
Actions *[]CheckRunAction `json:"actions,omitempty"`
}
CreateCheckSuiteInput is an autogenerated input type of CreateCheckSuite.
type CreateCheckSuiteInput struct {
// The Node ID of the repository. (Required.)
RepositoryID ID `json:"repositoryId"`
// The SHA of the head commit. (Required.)
HeadSha GitObjectID `json:"headSha"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
CreateCommitOnBranchInput is an autogenerated input type of CreateCommitOnBranch.
type CreateCommitOnBranchInput struct {
// The Ref to be updated. Must be a branch. (Required.)
Branch CommittableBranch `json:"branch"`
// The commit message the be included with the commit. (Required.)
Message CommitMessage `json:"message"`
// The git commit oid expected at the head of the branch prior to the commit. (Required.)
ExpectedHeadOid GitObjectID `json:"expectedHeadOid"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
// A description of changes to files in this commit. (Optional.)
FileChanges *FileChanges `json:"fileChanges,omitempty"`
}
CreateDeploymentInput is an autogenerated input type of CreateDeployment.
type CreateDeploymentInput struct {
// The node ID of the repository. (Required.)
RepositoryID ID `json:"repositoryId"`
// The node ID of the ref to be deployed. (Required.)
RefID ID `json:"refId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
// Attempt to automatically merge the default branch into the requested ref, defaults to true. (Optional.)
AutoMerge *Boolean `json:"autoMerge,omitempty"`
// The status contexts to verify against commit status checks. To bypass required contexts, pass an empty array. Defaults to all unique contexts. (Optional.)
RequiredContexts *[]String `json:"requiredContexts,omitempty"`
// Short description of the deployment. (Optional.)
Description *String `json:"description,omitempty"`
// Name for the target deployment environment. (Optional.)
Environment *String `json:"environment,omitempty"`
// Specifies a task to execute. (Optional.)
Task *String `json:"task,omitempty"`
// JSON payload with extra information about the deployment. (Optional.)
Payload *String `json:"payload,omitempty"`
}
CreateDeploymentStatusInput is an autogenerated input type of CreateDeploymentStatus.
type CreateDeploymentStatusInput struct {
// The node ID of the deployment. (Required.)
DeploymentID ID `json:"deploymentId"`
// The state of the deployment. (Required.)
State DeploymentStatusState `json:"state"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
// A short description of the status. Maximum length of 140 characters. (Optional.)
Description *String `json:"description,omitempty"`
// If provided, updates the environment of the deploy. Otherwise, does not modify the environment. (Optional.)
Environment *String `json:"environment,omitempty"`
// Sets the URL for accessing your environment. (Optional.)
EnvironmentURL *String `json:"environmentUrl,omitempty"`
// Adds a new inactive status to all non-transient, non-production environment deployments with the same repository and environment name as the created status's deployment. (Optional.)
AutoInactive *Boolean `json:"autoInactive,omitempty"`
// The log URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. (Optional.)
LogURL *String `json:"logUrl,omitempty"`
}
CreateDiscussionInput is an autogenerated input type of CreateDiscussion.
type CreateDiscussionInput struct {
// The id of the repository on which to create the discussion. (Required.)
RepositoryID ID `json:"repositoryId"`
// The title of the discussion. (Required.)
Title String `json:"title"`
// The body of the discussion. (Required.)
Body String `json:"body"`
// The id of the discussion category to associate with this discussion. (Required.)
CategoryID ID `json:"categoryId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
CreateEnterpriseOrganizationInput is an autogenerated input type of CreateEnterpriseOrganization.
type CreateEnterpriseOrganizationInput struct {
// The ID of the enterprise owning the new organization. (Required.)
EnterpriseID ID `json:"enterpriseId"`
// The login of the new organization. (Required.)
Login String `json:"login"`
// The profile name of the new organization. (Required.)
ProfileName String `json:"profileName"`
// The email used for sending billing receipts. (Required.)
BillingEmail String `json:"billingEmail"`
// The logins for the administrators of the new organization. (Required.)
AdminLogins []String `json:"adminLogins"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
CreateEnvironmentInput is an autogenerated input type of CreateEnvironment.
type CreateEnvironmentInput struct {
// The node ID of the repository. (Required.)
RepositoryID ID `json:"repositoryId"`
// The name of the environment. (Required.)
Name String `json:"name"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
CreateIpAllowListEntryInput is an autogenerated input type of CreateIpAllowListEntry.
type CreateIpAllowListEntryInput struct {
// The ID of the owner for which to create the new IP allow list entry. (Required.)
OwnerID ID `json:"ownerId"`
// An IP address or range of addresses in CIDR notation. (Required.)
AllowListValue String `json:"allowListValue"`
// Whether the IP allow list entry is active when an IP allow list is enabled. (Required.)
IsActive Boolean `json:"isActive"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
// An optional name for the IP allow list entry. (Optional.)
Name *String `json:"name,omitempty"`
}
CreateIssueInput is an autogenerated input type of CreateIssue.
type CreateIssueInput struct {
// The Node ID of the repository. (Required.)
RepositoryID ID `json:"repositoryId"`
// The title for the issue. (Required.)
Title String `json:"title"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
// The body for the issue description. (Optional.)
Body *String `json:"body,omitempty"`
// The Node ID for the user assignee for this issue. (Optional.)
AssigneeIDs *[]ID `json:"assigneeIds,omitempty"`
// The Node ID of the milestone for this issue. (Optional.)
MilestoneID *ID `json:"milestoneId,omitempty"`
// An array of Node IDs of labels for this issue. (Optional.)
LabelIDs *[]ID `json:"labelIds,omitempty"`
// An array of Node IDs for projects associated with this issue. (Optional.)
ProjectIDs *[]ID `json:"projectIds,omitempty"`
// The name of an issue template in the repository, assigns labels and assignees from the template to the issue. (Optional.)
IssueTemplate *String `json:"issueTemplate,omitempty"`
}
CreateLabelInput is an autogenerated input type of CreateLabel.
type CreateLabelInput struct {
// The Node ID of the repository. (Required.)
RepositoryID ID `json:"repositoryId"`
// A 6 character hex code, without the leading #, identifying the color of the label. (Required.)
Color String `json:"color"`
// The name of the label. (Required.)
Name String `json:"name"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
// A brief description of the label, such as its purpose. (Optional.)
Description *String `json:"description,omitempty"`
}
CreateLinkedBranchInput is an autogenerated input type of CreateLinkedBranch.
type CreateLinkedBranchInput struct {
// ID of the issue to link to. (Required.)
IssueID ID `json:"issueId"`
// The commit SHA to base the new branch on. (Required.)
Oid GitObjectID `json:"oid"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
// The name of the new branch. Defaults to issue number and title. (Optional.)
Name *String `json:"name,omitempty"`
// ID of the repository to create the branch in. Defaults to the issue repository. (Optional.)
RepositoryID *ID `json:"repositoryId,omitempty"`
}
CreateMigrationSourceInput is an autogenerated input type of CreateMigrationSource.
type CreateMigrationSourceInput struct {
// The migration source name. (Required.)
Name String `json:"name"`
// The migration source type. (Required.)
Type MigrationSourceType `json:"type"`
// The ID of the organization that will own the migration source. (Required.)
OwnerID ID `json:"ownerId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
// The migration source URL, for example `https://github.com` or `https://monalisa.ghe.com`. (Optional.)
URL *String `json:"url,omitempty"`
// The migration source access token. (Optional.)
AccessToken *String `json:"accessToken,omitempty"`
// The GitHub personal access token of the user importing to the target repository. (Optional.)
GitHubPat *String `json:"githubPat,omitempty"`
}
CreateProjectInput is an autogenerated input type of CreateProject.
type CreateProjectInput struct {
// The owner ID to create the project under. (Required.)
OwnerID ID `json:"ownerId"`
// The name of project. (Required.)
Name String `json:"name"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
// The description of project. (Optional.)
Body *String `json:"body,omitempty"`
// The name of the GitHub-provided template. (Optional.)
Template *ProjectTemplate `json:"template,omitempty"`
// A list of repository IDs to create as linked repositories for the project. (Optional.)
RepositoryIDs *[]ID `json:"repositoryIds,omitempty"`
}
CreateProjectV2FieldInput is an autogenerated input type of CreateProjectV2Field.
type CreateProjectV2FieldInput struct {
// The ID of the Project to create the field in. (Required.)
ProjectID ID `json:"projectId"`
// The data type of the field. (Required.)
DataType ProjectV2CustomFieldType `json:"dataType"`
// The name of the field. (Required.)
Name String `json:"name"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
// Options for a single select field. At least one value is required if data_type is SINGLE_SELECT. (Optional.)
SingleSelectOptions *[]ProjectV2SingleSelectFieldOptionInput `json:"singleSelectOptions,omitempty"`
}
CreateProjectV2Input is an autogenerated input type of CreateProjectV2.
type CreateProjectV2Input struct {
// The owner ID to create the project under. (Required.)
OwnerID ID `json:"ownerId"`
// The title of the project. (Required.)
Title String `json:"title"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
// The repository to link the project to. (Optional.)
RepositoryID *ID `json:"repositoryId,omitempty"`
// The team to link the project to. The team will be granted read permissions. (Optional.)
TeamID *ID `json:"teamId,omitempty"`
}
CreateProjectV2StatusUpdateInput is an autogenerated input type of CreateProjectV2StatusUpdate.
type CreateProjectV2StatusUpdateInput struct {
// The ID of the Project to create the status update in. (Required.)
ProjectID ID `json:"projectId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
// The start date of the status update. (Optional.)
StartDate *Date `json:"startDate,omitempty"`
// The target date of the status update. (Optional.)
TargetDate *Date `json:"targetDate,omitempty"`
// The status of the status update. (Optional.)
Status *ProjectV2StatusUpdateStatus `json:"status,omitempty"`
// The body of the status update. (Optional.)
Body *String `json:"body,omitempty"`
}
CreatePullRequestInput is an autogenerated input type of CreatePullRequest.
type CreatePullRequestInput struct {
// The Node ID of the repository. (Required.)
RepositoryID ID `json:"repositoryId"`
// The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository. (Required.)
BaseRefName String `json:"baseRefName"`
// The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace `head_ref_name` with a user like this: `username:branch`. (Required.)
HeadRefName String `json:"headRefName"`
// The title of the pull request. (Required.)
Title String `json:"title"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
// The Node ID of the head repository. (Optional.)
HeadRepositoryID *ID `json:"headRepositoryId,omitempty"`
// The contents of the pull request. (Optional.)
Body *String `json:"body,omitempty"`
// Indicates whether maintainers can modify the pull request. (Optional.)
MaintainerCanModify *Boolean `json:"maintainerCanModify,omitempty"`
// Indicates whether this pull request should be a draft. (Optional.)
Draft *Boolean `json:"draft,omitempty"`
}
CreateRefInput is an autogenerated input type of CreateRef.
type CreateRefInput struct {
// The Node ID of the Repository to create the Ref in. (Required.)
RepositoryID ID `json:"repositoryId"`
// The fully qualified name of the new Ref (ie: `refs/heads/my_new_branch`). (Required.)
Name String `json:"name"`
// The GitObjectID that the new Ref shall target. Must point to a commit. (Required.)
Oid GitObjectID `json:"oid"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
CreateRepositoryInput is an autogenerated input type of CreateRepository.
type CreateRepositoryInput struct {
// The name of the new repository. (Required.)
Name String `json:"name"`
// Indicates the repository's visibility level. (Required.)
Visibility RepositoryVisibility `json:"visibility"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
// The ID of the owner for the new repository. (Optional.)
OwnerID *ID `json:"ownerId,omitempty"`
// A short description of the new repository. (Optional.)
Description *String `json:"description,omitempty"`
// Whether this repository should be marked as a template such that anyone who can access it can create new repositories with the same files and directory structure. (Optional.)
Template *Boolean `json:"template,omitempty"`
// The URL for a web page about this repository. (Optional.)
HomepageURL *URI `json:"homepageUrl,omitempty"`
// Indicates if the repository should have the wiki feature enabled. (Optional.)
HasWikiEnabled *Boolean `json:"hasWikiEnabled,omitempty"`
// Indicates if the repository should have the issues feature enabled. (Optional.)
HasIssuesEnabled *Boolean `json:"hasIssuesEnabled,omitempty"`
// When an organization is specified as the owner, this ID identifies the team that should be granted access to the new repository. (Optional.)
TeamID *ID `json:"teamId,omitempty"`
}
CreateRepositoryRulesetInput is an autogenerated input type of CreateRepositoryRuleset.
type CreateRepositoryRulesetInput struct {
// The global relay id of the source in which a new ruleset should be created in. (Required.)
SourceID ID `json:"sourceId"`
// The name of the ruleset. (Required.)
Name String `json:"name"`
// The set of conditions for this ruleset. (Required.)
Conditions RepositoryRuleConditionsInput `json:"conditions"`
// The enforcement level for this ruleset. (Required.)
Enforcement RuleEnforcement `json:"enforcement"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
// The target of the ruleset. (Optional.)
Target *RepositoryRulesetTarget `json:"target,omitempty"`
// The list of rules for this ruleset. (Optional.)
Rules *[]RepositoryRuleInput `json:"rules,omitempty"`
// A list of actors that are allowed to bypass rules in this ruleset. (Optional.)
BypassActors *[]RepositoryRulesetBypassActorInput `json:"bypassActors,omitempty"`
}
CreateSponsorsListingInput is an autogenerated input type of CreateSponsorsListing.
type CreateSponsorsListingInput struct {
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
// The username of the organization to create a GitHub Sponsors profile for, if desired. Defaults to creating a GitHub Sponsors profile for the authenticated user if omitted. (Optional.)
SponsorableLogin *String `json:"sponsorableLogin,omitempty"`
// The username of the supported fiscal host's GitHub organization, if you want to receive sponsorship payouts through a fiscal host rather than directly to a bank account. For example, 'Open-Source-Collective' for Open Source Collective or 'numfocus' for numFOCUS. Case insensitive. See https://docs.github.com/sponsors/receiving-sponsorships-through-github-sponsors/using-a-fiscal-host-to-receive-github-sponsors-payouts for more information. (Optional.)
FiscalHostLogin *String `json:"fiscalHostLogin,omitempty"`
// The URL for your profile page on the fiscal host's website, e.g., https://opencollective.com/babel or https://numfocus.org/project/bokeh. Required if fiscalHostLogin is specified. (Optional.)
FiscallyHostedProjectProfileURL *String `json:"fiscallyHostedProjectProfileUrl,omitempty"`
// The country or region where the sponsorable's bank account is located. Required if fiscalHostLogin is not specified, ignored when fiscalHostLogin is specified. (Optional.)
BillingCountryOrRegionCode *SponsorsCountryOrRegionCode `json:"billingCountryOrRegionCode,omitempty"`
// The country or region where the sponsorable resides. This is for tax purposes. Required if the sponsorable is yourself, ignored when sponsorableLogin specifies an organization. (Optional.)
ResidenceCountryOrRegionCode *SponsorsCountryOrRegionCode `json:"residenceCountryOrRegionCode,omitempty"`
// The email address we should use to contact you about the GitHub Sponsors profile being created. This will not be shared publicly. Must be a verified email address already on your GitHub account. Only relevant when the sponsorable is yourself. Defaults to your primary email address on file if omitted. (Optional.)
ContactEmail *String `json:"contactEmail,omitempty"`
// Provide an introduction to serve as the main focus that appears on your GitHub Sponsors profile. It's a great opportunity to help potential sponsors learn more about you, your work, and why their sponsorship is important to you. GitHub-flavored Markdown is supported. (Optional.)
FullDescription *String `json:"fullDescription,omitempty"`
}
CreateSponsorsTierInput is an autogenerated input type of CreateSponsorsTier.
type CreateSponsorsTierInput struct {
// The value of the new tier in US dollars. Valid values: 1-12000. (Required.)
Amount Int `json:"amount"`
// A description of what this tier is, what perks sponsors might receive, what a sponsorship at this tier means for you, etc. (Required.)
Description String `json:"description"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
// The ID of the user or organization who owns the GitHub Sponsors profile. Defaults to the current user if omitted and sponsorableLogin is not given. (Optional.)
SponsorableID *ID `json:"sponsorableId,omitempty"`
// The username of the user or organization who owns the GitHub Sponsors profile. Defaults to the current user if omitted and sponsorableId is not given. (Optional.)
SponsorableLogin *String `json:"sponsorableLogin,omitempty"`
// Whether sponsorships using this tier should happen monthly/yearly or just once. (Optional.)
IsRecurring *Boolean `json:"isRecurring,omitempty"`
// Optional ID of the private repository that sponsors at this tier should gain read-only access to. Must be owned by an organization. (Optional.)
RepositoryID *ID `json:"repositoryId,omitempty"`
// Optional login of the organization owner of the private repository that sponsors at this tier should gain read-only access to. Necessary if repositoryName is given. Will be ignored if repositoryId is given. (Optional.)
RepositoryOwnerLogin *String `json:"repositoryOwnerLogin,omitempty"`
// Optional name of the private repository that sponsors at this tier should gain read-only access to. Must be owned by an organization. Necessary if repositoryOwnerLogin is given. Will be ignored if repositoryId is given. (Optional.)
RepositoryName *String `json:"repositoryName,omitempty"`
// Optional message new sponsors at this tier will receive. (Optional.)
WelcomeMessage *String `json:"welcomeMessage,omitempty"`
// Whether to make the tier available immediately for sponsors to choose. Defaults to creating a draft tier that will not be publicly visible. (Optional.)
Publish *Boolean `json:"publish,omitempty"`
}
CreateSponsorshipInput is an autogenerated input type of CreateSponsorship.
type CreateSponsorshipInput struct {
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
// The ID of the user or organization who is acting as the sponsor, paying for the sponsorship. Required if sponsorLogin is not given. (Optional.)
SponsorID *ID `json:"sponsorId,omitempty"`
// The username of the user or organization who is acting as the sponsor, paying for the sponsorship. Required if sponsorId is not given. (Optional.)
SponsorLogin *String `json:"sponsorLogin,omitempty"`
// The ID of the user or organization who is receiving the sponsorship. Required if sponsorableLogin is not given. (Optional.)
SponsorableID *ID `json:"sponsorableId,omitempty"`
// The username of the user or organization who is receiving the sponsorship. Required if sponsorableId is not given. (Optional.)
SponsorableLogin *String `json:"sponsorableLogin,omitempty"`
// The ID of one of sponsorable's existing tiers to sponsor at. Required if amount is not specified. (Optional.)
TierID *ID `json:"tierId,omitempty"`
// The amount to pay to the sponsorable in US dollars. Required if a tierId is not specified. Valid values: 1-12000. (Optional.)
Amount *Int `json:"amount,omitempty"`
// Whether the sponsorship should happen monthly/yearly or just this one time. Required if a tierId is not specified. (Optional.)
IsRecurring *Boolean `json:"isRecurring,omitempty"`
// Whether the sponsor should receive email updates from the sponsorable. (Optional.)
ReceiveEmails *Boolean `json:"receiveEmails,omitempty"`
// Specify whether others should be able to see that the sponsor is sponsoring the sponsorable. Public visibility still does not reveal which tier is used. (Optional.)
PrivacyLevel *SponsorshipPrivacy `json:"privacyLevel,omitempty"`
}
CreateSponsorshipsInput is an autogenerated input type of CreateSponsorships.
type CreateSponsorshipsInput struct {
// The username of the user or organization who is acting as the sponsor, paying for the sponsorships. (Required.)
SponsorLogin String `json:"sponsorLogin"`
// The list of maintainers to sponsor and for how much apiece. (Required.)
Sponsorships []BulkSponsorship `json:"sponsorships"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
// Whether the sponsor should receive email updates from the sponsorables. (Optional.)
ReceiveEmails *Boolean `json:"receiveEmails,omitempty"`
// Specify whether others should be able to see that the sponsor is sponsoring the sponsorables. Public visibility still does not reveal the dollar value of the sponsorship. (Optional.)
PrivacyLevel *SponsorshipPrivacy `json:"privacyLevel,omitempty"`
// Whether the sponsorships created should continue each billing cycle for the sponsor (monthly or annually), versus lasting only a single month. Defaults to one-time sponsorships. (Optional.)
Recurring *Boolean `json:"recurring,omitempty"`
}
CreateTeamDiscussionCommentInput is an autogenerated input type of CreateTeamDiscussionComment.
type CreateTeamDiscussionCommentInput struct {
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
// The ID of the discussion to which the comment belongs. This field is required. **Upcoming Change on 2024-07-01 UTC** **Description:** `discussionId` will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. **Reason:** The Team Discussions feature is deprecated in favor of Organization Discussions. (Optional.)
DiscussionID *ID `json:"discussionId,omitempty"`
// The content of the comment. This field is required. **Upcoming Change on 2024-07-01 UTC** **Description:** `body` will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. **Reason:** The Team Discussions feature is deprecated in favor of Organization Discussions. (Optional.)
Body *String `json:"body,omitempty"`
}
CreateTeamDiscussionInput is an autogenerated input type of CreateTeamDiscussion.
type CreateTeamDiscussionInput struct {
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
// The ID of the team to which the discussion belongs. This field is required. **Upcoming Change on 2024-07-01 UTC** **Description:** `teamId` will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. **Reason:** The Team Discussions feature is deprecated in favor of Organization Discussions. (Optional.)
TeamID *ID `json:"teamId,omitempty"`
// The title of the discussion. This field is required. **Upcoming Change on 2024-07-01 UTC** **Description:** `title` will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. **Reason:** The Team Discussions feature is deprecated in favor of Organization Discussions. (Optional.)
Title *String `json:"title,omitempty"`
// The content of the discussion. This field is required. **Upcoming Change on 2024-07-01 UTC** **Description:** `body` will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. **Reason:** The Team Discussions feature is deprecated in favor of Organization Discussions. (Optional.)
Body *String `json:"body,omitempty"`
// If true, restricts the visibility of this discussion to team members and organization owners. If false or not specified, allows any organization member to view this discussion. **Upcoming Change on 2024-07-01 UTC** **Description:** `private` will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. **Reason:** The Team Discussions feature is deprecated in favor of Organization Discussions. (Optional.)
Private *Boolean `json:"private,omitempty"`
}
CreateUserListInput is an autogenerated input type of CreateUserList.
type CreateUserListInput struct {
// The name of the new list. (Required.)
Name String `json:"name"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
// A description of the list. (Optional.)
Description *String `json:"description,omitempty"`
// Whether or not the list is private. (Optional.)
IsPrivate *Boolean `json:"isPrivate,omitempty"`
}
Date is an ISO-8601 encoded date.
type Date struct{ time.Time }
func NewDate(v Date) *Date
NewDate is a helper to make a new *Date.
DateTime is an ISO-8601 encoded UTC date.
type DateTime struct{ time.Time }
func NewDateTime(v DateTime) *DateTime
NewDateTime is a helper to make a new *DateTime.
DeclineTopicSuggestionInput is an autogenerated input type of DeclineTopicSuggestion.
type DeclineTopicSuggestionInput struct {
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
// 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. (Optional.)
RepositoryID *ID `json:"repositoryId,omitempty"`
// 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. (Optional.)
Name *String `json:"name,omitempty"`
// The reason why the suggested topic is declined. **Upcoming Change on 2024-04-01 UTC** **Description:** `reason` will be removed. **Reason:** Suggested topics are no longer supported. (Optional.)
Reason *TopicSuggestionDeclineReason `json:"reason,omitempty"`
}
DefaultRepositoryPermissionField represents the possible base permissions for repositories.
type DefaultRepositoryPermissionField string
The possible base permissions for repositories.
const (
DefaultRepositoryPermissionFieldNone DefaultRepositoryPermissionField = "NONE" // No access.
DefaultRepositoryPermissionFieldRead DefaultRepositoryPermissionField = "READ" // Can read repos by default.
DefaultRepositoryPermissionFieldWrite DefaultRepositoryPermissionField = "WRITE" // Can read and write repos by default.
DefaultRepositoryPermissionFieldAdmin DefaultRepositoryPermissionField = "ADMIN" // Can read, write, and administrate repos by default.
)
DeleteBranchProtectionRuleInput is an autogenerated input type of DeleteBranchProtectionRule.
type DeleteBranchProtectionRuleInput struct {
// The global relay id of the branch protection rule to be deleted. (Required.)
BranchProtectionRuleID ID `json:"branchProtectionRuleId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
DeleteDeploymentInput is an autogenerated input type of DeleteDeployment.
type DeleteDeploymentInput struct {
// The Node ID of the deployment to be deleted. (Required.)
ID ID `json:"id"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
DeleteDiscussionCommentInput is an autogenerated input type of DeleteDiscussionComment.
type DeleteDiscussionCommentInput struct {
// The Node id of the discussion comment to delete. (Required.)
ID ID `json:"id"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
DeleteDiscussionInput is an autogenerated input type of DeleteDiscussion.
type DeleteDiscussionInput struct {
// The id of the discussion to delete. (Required.)
ID ID `json:"id"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
DeleteEnvironmentInput is an autogenerated input type of DeleteEnvironment.
type DeleteEnvironmentInput struct {
// The Node ID of the environment to be deleted. (Required.)
ID ID `json:"id"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
DeleteIpAllowListEntryInput is an autogenerated input type of DeleteIpAllowListEntry.
type DeleteIpAllowListEntryInput struct {
// The ID of the IP allow list entry to delete. (Required.)
IPAllowListEntryID ID `json:"ipAllowListEntryId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
DeleteIssueCommentInput is an autogenerated input type of DeleteIssueComment.
type DeleteIssueCommentInput struct {
// The ID of the comment to delete. (Required.)
ID ID `json:"id"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
DeleteIssueInput is an autogenerated input type of DeleteIssue.
type DeleteIssueInput struct {
// The ID of the issue to delete. (Required.)
IssueID ID `json:"issueId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
DeleteLabelInput is an autogenerated input type of DeleteLabel.
type DeleteLabelInput struct {
// The Node ID of the label to be deleted. (Required.)
ID ID `json:"id"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
DeleteLinkedBranchInput is an autogenerated input type of DeleteLinkedBranch.
type DeleteLinkedBranchInput struct {
// The ID of the linked branch. (Required.)
LinkedBranchID ID `json:"linkedBranchId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
DeletePackageVersionInput is an autogenerated input type of DeletePackageVersion.
type DeletePackageVersionInput struct {
// The ID of the package version to be deleted. (Required.)
PackageVersionID ID `json:"packageVersionId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
DeleteProjectCardInput is an autogenerated input type of DeleteProjectCard.
type DeleteProjectCardInput struct {
// The id of the card to delete. (Required.)
CardID ID `json:"cardId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
DeleteProjectColumnInput is an autogenerated input type of DeleteProjectColumn.
type DeleteProjectColumnInput struct {
// The id of the column to delete. (Required.)
ColumnID ID `json:"columnId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
DeleteProjectInput is an autogenerated input type of DeleteProject.
type DeleteProjectInput struct {
// The Project ID to update. (Required.)
ProjectID ID `json:"projectId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
DeleteProjectV2FieldInput is an autogenerated input type of DeleteProjectV2Field.
type DeleteProjectV2FieldInput struct {
// The ID of the field to delete. (Required.)
FieldID ID `json:"fieldId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
DeleteProjectV2Input is an autogenerated input type of DeleteProjectV2.
type DeleteProjectV2Input struct {
// The ID of the Project to delete. (Required.)
ProjectID ID `json:"projectId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
DeleteProjectV2ItemInput is an autogenerated input type of DeleteProjectV2Item.
type DeleteProjectV2ItemInput struct {
// The ID of the Project from which the item should be removed. (Required.)
ProjectID ID `json:"projectId"`
// The ID of the item to be removed. (Required.)
ItemID ID `json:"itemId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
DeleteProjectV2StatusUpdateInput is an autogenerated input type of DeleteProjectV2StatusUpdate.
type DeleteProjectV2StatusUpdateInput struct {
// The ID of the status update to be removed. (Required.)
StatusUpdateID ID `json:"statusUpdateId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
DeleteProjectV2WorkflowInput is an autogenerated input type of DeleteProjectV2Workflow.
type DeleteProjectV2WorkflowInput struct {
// The ID of the workflow to be removed. (Required.)
WorkflowID ID `json:"workflowId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
DeletePullRequestReviewCommentInput is an autogenerated input type of DeletePullRequestReviewComment.
type DeletePullRequestReviewCommentInput struct {
// The ID of the comment to delete. (Required.)
ID ID `json:"id"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
DeletePullRequestReviewInput is an autogenerated input type of DeletePullRequestReview.
type DeletePullRequestReviewInput struct {
// The Node ID of the pull request review to delete. (Required.)
PullRequestReviewID ID `json:"pullRequestReviewId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
DeleteRefInput is an autogenerated input type of DeleteRef.
type DeleteRefInput struct {
// The Node ID of the Ref to be deleted. (Required.)
RefID ID `json:"refId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
DeleteRepositoryRulesetInput is an autogenerated input type of DeleteRepositoryRuleset.
type DeleteRepositoryRulesetInput struct {
// The global relay id of the repository ruleset to be deleted. (Required.)
RepositoryRulesetID ID `json:"repositoryRulesetId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
DeleteTeamDiscussionCommentInput is an autogenerated input type of DeleteTeamDiscussionComment.
type DeleteTeamDiscussionCommentInput struct {
// The ID of the comment to delete. (Required.)
ID ID `json:"id"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
DeleteTeamDiscussionInput is an autogenerated input type of DeleteTeamDiscussion.
type DeleteTeamDiscussionInput struct {
// The discussion ID to delete. (Required.)
ID ID `json:"id"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
DeleteUserListInput is an autogenerated input type of DeleteUserList.
type DeleteUserListInput struct {
// The ID of the list to delete. (Required.)
ListID ID `json:"listId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
DeleteVerifiableDomainInput is an autogenerated input type of DeleteVerifiableDomain.
type DeleteVerifiableDomainInput struct {
// The ID of the verifiable domain to delete. (Required.)
ID ID `json:"id"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
DependencyGraphEcosystem represents the possible ecosystems of a dependency graph package.
type DependencyGraphEcosystem string
The possible ecosystems of a dependency graph package.
const (
DependencyGraphEcosystemRubygems DependencyGraphEcosystem = "RUBYGEMS" // Ruby gems hosted at RubyGems.org.
DependencyGraphEcosystemNpm DependencyGraphEcosystem = "NPM" // JavaScript packages hosted at npmjs.com.
DependencyGraphEcosystemPip DependencyGraphEcosystem = "PIP" // Python packages hosted at PyPI.org.
DependencyGraphEcosystemMaven DependencyGraphEcosystem = "MAVEN" // Java artifacts hosted at the Maven central repository.
DependencyGraphEcosystemNuget DependencyGraphEcosystem = "NUGET" // .NET packages hosted at the NuGet Gallery.
DependencyGraphEcosystemComposer DependencyGraphEcosystem = "COMPOSER" // PHP packages hosted at packagist.org.
DependencyGraphEcosystemGo DependencyGraphEcosystem = "GO" // Go modules.
DependencyGraphEcosystemActions DependencyGraphEcosystem = "ACTIONS" // GitHub Actions.
DependencyGraphEcosystemRust DependencyGraphEcosystem = "RUST" // Rust crates.
DependencyGraphEcosystemPub DependencyGraphEcosystem = "PUB" // Dart packages hosted at pub.dev.
DependencyGraphEcosystemSwift DependencyGraphEcosystem = "SWIFT" // Swift packages.
)
DeploymentOrder represents ordering options for deployment connections.
type DeploymentOrder struct {
// The field to order deployments by. (Required.)
Field DeploymentOrderField `json:"field"`
// The ordering direction. (Required.)
Direction OrderDirection `json:"direction"`
}
DeploymentOrderField represents properties by which deployment connections can be ordered.
type DeploymentOrderField string
Properties by which deployment connections can be ordered.
const (
DeploymentOrderFieldCreatedAt DeploymentOrderField = "CREATED_AT" // Order collection by creation time.
)
DeploymentProtectionRuleType represents the possible protection rule types.
type DeploymentProtectionRuleType string
The possible protection rule types.
const (
DeploymentProtectionRuleTypeRequiredReviewers DeploymentProtectionRuleType = "REQUIRED_REVIEWERS" // Required reviewers.
DeploymentProtectionRuleTypeWaitTimer DeploymentProtectionRuleType = "WAIT_TIMER" // Wait timer.
DeploymentProtectionRuleTypeBranchPolicy DeploymentProtectionRuleType = "BRANCH_POLICY" // Branch policy.
)
DeploymentReviewState represents the possible states for a deployment review.
type DeploymentReviewState string
The possible states for a deployment review.
const (
DeploymentReviewStateApproved DeploymentReviewState = "APPROVED" // The deployment was approved.
DeploymentReviewStateRejected DeploymentReviewState = "REJECTED" // The deployment was rejected.
)
DeploymentState represents the possible states in which a deployment can be.
type DeploymentState string
The possible states in which a deployment can be.
const (
DeploymentStateAbandoned DeploymentState = "ABANDONED" // The pending deployment was not updated after 30 minutes.
DeploymentStateActive DeploymentState = "ACTIVE" // The deployment is currently active.
DeploymentStateDestroyed DeploymentState = "DESTROYED" // An inactive transient deployment.
DeploymentStateError DeploymentState = "ERROR" // The deployment experienced an error.
DeploymentStateFailure DeploymentState = "FAILURE" // The deployment has failed.
DeploymentStateInactive DeploymentState = "INACTIVE" // The deployment is inactive.
DeploymentStatePending DeploymentState = "PENDING" // The deployment is pending.
DeploymentStateSuccess DeploymentState = "SUCCESS" // The deployment was successful.
DeploymentStateQueued DeploymentState = "QUEUED" // The deployment has queued.
DeploymentStateInProgress DeploymentState = "IN_PROGRESS" // The deployment is in progress.
DeploymentStateWaiting DeploymentState = "WAITING" // The deployment is waiting.
)
DeploymentStatusState represents the possible states for a deployment status.
type DeploymentStatusState string
The possible states for a deployment status.
const (
DeploymentStatusStatePending DeploymentStatusState = "PENDING" // The deployment is pending.
DeploymentStatusStateSuccess DeploymentStatusState = "SUCCESS" // The deployment was successful.
DeploymentStatusStateFailure DeploymentStatusState = "FAILURE" // The deployment has failed.
DeploymentStatusStateInactive DeploymentStatusState = "INACTIVE" // The deployment is inactive.
DeploymentStatusStateError DeploymentStatusState = "ERROR" // The deployment experienced an error.
DeploymentStatusStateQueued DeploymentStatusState = "QUEUED" // The deployment is queued.
DeploymentStatusStateInProgress DeploymentStatusState = "IN_PROGRESS" // The deployment is in progress.
DeploymentStatusStateWaiting DeploymentStatusState = "WAITING" // The deployment is waiting.
)
DequeuePullRequestInput is an autogenerated input type of DequeuePullRequest.
type DequeuePullRequestInput struct {
// The ID of the pull request to be dequeued. (Required.)
ID ID `json:"id"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
DiffSide represents the possible sides of a diff.
type DiffSide string
The possible sides of a diff.
const (
DiffSideLeft DiffSide = "LEFT" // The left side of the diff.
DiffSideRight DiffSide = "RIGHT" // The right side of the diff.
)
DisablePullRequestAutoMergeInput is an autogenerated input type of DisablePullRequestAutoMerge.
type DisablePullRequestAutoMergeInput struct {
// ID of the pull request to disable auto merge on. (Required.)
PullRequestID ID `json:"pullRequestId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
DiscussionCloseReason represents the possible reasons for closing a discussion.
type DiscussionCloseReason string
The possible reasons for closing a discussion.
const (
DiscussionCloseReasonResolved DiscussionCloseReason = "RESOLVED" // The discussion has been resolved.
DiscussionCloseReasonOutdated DiscussionCloseReason = "OUTDATED" // The discussion is no longer relevant.
DiscussionCloseReasonDuplicate DiscussionCloseReason = "DUPLICATE" // The discussion is a duplicate of another.
)
DiscussionOrder represents ways in which lists of discussions can be ordered upon return.
type DiscussionOrder struct {
// The field by which to order discussions. (Required.)
Field DiscussionOrderField `json:"field"`
// The direction in which to order discussions by the specified field. (Required.)
Direction OrderDirection `json:"direction"`
}
DiscussionOrderField represents properties by which discussion connections can be ordered.
type DiscussionOrderField string
Properties by which discussion connections can be ordered.
const (
DiscussionOrderFieldCreatedAt DiscussionOrderField = "CREATED_AT" // Order discussions by creation time.
DiscussionOrderFieldUpdatedAt DiscussionOrderField = "UPDATED_AT" // Order discussions by most recent modification time.
)
DiscussionPollOptionOrder represents ordering options for discussion poll option connections.
type DiscussionPollOptionOrder struct {
// The field to order poll options by. (Required.)
Field DiscussionPollOptionOrderField `json:"field"`
// The ordering direction. (Required.)
Direction OrderDirection `json:"direction"`
}
DiscussionPollOptionOrderField represents properties by which discussion poll option connections can be ordered.
type DiscussionPollOptionOrderField string
Properties by which discussion poll option connections can be ordered.
const (
DiscussionPollOptionOrderFieldAuthoredOrder DiscussionPollOptionOrderField = "AUTHORED_ORDER" // Order poll options by the order that the poll author specified when creating the poll.
DiscussionPollOptionOrderFieldVoteCount DiscussionPollOptionOrderField = "VOTE_COUNT" // Order poll options by the number of votes it has.
)
DiscussionState represents the possible states of a discussion.
type DiscussionState string
The possible states of a discussion.
const (
DiscussionStateOpen DiscussionState = "OPEN" // A discussion that is open.
DiscussionStateClosed DiscussionState = "CLOSED" // A discussion that has been closed.
)
DiscussionStateReason represents the possible state reasons of a discussion.
type DiscussionStateReason string
The possible state reasons of a discussion.
const (
DiscussionStateReasonResolved DiscussionStateReason = "RESOLVED" // The discussion has been resolved.
DiscussionStateReasonOutdated DiscussionStateReason = "OUTDATED" // The discussion is no longer relevant.
DiscussionStateReasonDuplicate DiscussionStateReason = "DUPLICATE" // The discussion is a duplicate of another.
DiscussionStateReasonReopened DiscussionStateReason = "REOPENED" // The discussion was reopened.
)
DismissPullRequestReviewInput is an autogenerated input type of DismissPullRequestReview.
type DismissPullRequestReviewInput struct {
// The Node ID of the pull request review to modify. (Required.)
PullRequestReviewID ID `json:"pullRequestReviewId"`
// The contents of the pull request review dismissal message. (Required.)
Message String `json:"message"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
DismissReason represents the possible reasons that a Dependabot alert was dismissed.
type DismissReason string
The possible reasons that a Dependabot alert was dismissed.
const (
DismissReasonFixStarted DismissReason = "FIX_STARTED" // A fix has already been started.
DismissReasonNoBandwidth DismissReason = "NO_BANDWIDTH" // No bandwidth to fix this.
DismissReasonTolerableRisk DismissReason = "TOLERABLE_RISK" // Risk is tolerable to this project.
DismissReasonInaccurate DismissReason = "INACCURATE" // This alert is inaccurate or incorrect.
DismissReasonNotUsed DismissReason = "NOT_USED" // Vulnerable code is not actually used.
)
DismissRepositoryVulnerabilityAlertInput is an autogenerated input type of DismissRepositoryVulnerabilityAlert.
type DismissRepositoryVulnerabilityAlertInput struct {
// The Dependabot alert ID to dismiss. (Required.)
RepositoryVulnerabilityAlertID ID `json:"repositoryVulnerabilityAlertId"`
// The reason the Dependabot alert is being dismissed. (Required.)
DismissReason DismissReason `json:"dismissReason"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
DraftPullRequestReviewComment specifies a review comment to be left with a Pull Request Review.
type DraftPullRequestReviewComment struct {
// Path to the file being commented on. (Required.)
Path String `json:"path"`
// Position in the file to leave a comment on. (Required.)
Position Int `json:"position"`
// Body of the comment to leave. (Required.)
Body String `json:"body"`
}
DraftPullRequestReviewThread specifies a review comment thread to be left with a Pull Request Review.
type DraftPullRequestReviewThread struct {
// Path to the file being commented on. (Required.)
Path String `json:"path"`
// The line of the blob to which the thread refers. The end of the line range for multi-line comments. (Required.)
Line Int `json:"line"`
// Body of the comment to leave. (Required.)
Body String `json:"body"`
// 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. (Optional.)
Side *DiffSide `json:"side,omitempty"`
// The first line of the range to which the comment refers. (Optional.)
StartLine *Int `json:"startLine,omitempty"`
// The side of the diff on which the start line resides. (Optional.)
StartSide *DiffSide `json:"startSide,omitempty"`
}
EnablePullRequestAutoMergeInput is an autogenerated input type of EnablePullRequestAutoMerge.
type EnablePullRequestAutoMergeInput struct {
// ID of the pull request to enable auto-merge on. (Required.)
PullRequestID ID `json:"pullRequestId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
// Commit headline to use for the commit when the PR is mergable; if omitted, a default message will be used. NOTE: when merging with a merge queue any input value for commit headline is ignored. (Optional.)
CommitHeadline *String `json:"commitHeadline,omitempty"`
// Commit body to use for the commit when the PR is mergable; if omitted, a default message will be used. NOTE: when merging with a merge queue any input value for commit message is ignored. (Optional.)
CommitBody *String `json:"commitBody,omitempty"`
// The merge method to use. If omitted, defaults to `MERGE`. NOTE: when merging with a merge queue any input value for merge method is ignored. (Optional.)
MergeMethod *PullRequestMergeMethod `json:"mergeMethod,omitempty"`
// The email address to associate with this merge. (Optional.)
AuthorEmail *String `json:"authorEmail,omitempty"`
// The expected head OID of the pull request. (Optional.)
ExpectedHeadOid *GitObjectID `json:"expectedHeadOid,omitempty"`
}
EnqueuePullRequestInput is an autogenerated input type of EnqueuePullRequest.
type EnqueuePullRequestInput struct {
// The ID of the pull request to enqueue. (Required.)
PullRequestID ID `json:"pullRequestId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
// Add the pull request to the front of the queue. (Optional.)
Jump *Boolean `json:"jump,omitempty"`
// The expected head OID of the pull request. (Optional.)
ExpectedHeadOid *GitObjectID `json:"expectedHeadOid,omitempty"`
}
EnterpriseAdministratorInvitationOrder represents ordering options for enterprise administrator invitation connections.
type EnterpriseAdministratorInvitationOrder struct {
// The field to order enterprise administrator invitations by. (Required.)
Field EnterpriseAdministratorInvitationOrderField `json:"field"`
// The ordering direction. (Required.)
Direction OrderDirection `json:"direction"`
}
EnterpriseAdministratorInvitationOrderField represents properties by which enterprise administrator invitation connections can be ordered.
type EnterpriseAdministratorInvitationOrderField string
Properties by which enterprise administrator invitation connections can be ordered.
const (
EnterpriseAdministratorInvitationOrderFieldCreatedAt EnterpriseAdministratorInvitationOrderField = "CREATED_AT" // Order enterprise administrator member invitations by creation time.
)
EnterpriseAdministratorRole represents the possible administrator roles in an enterprise account.
type EnterpriseAdministratorRole string
The possible administrator roles in an enterprise account.
const (
EnterpriseAdministratorRoleOwner EnterpriseAdministratorRole = "OWNER" // Represents an owner of the enterprise account.
EnterpriseAdministratorRoleBillingManager EnterpriseAdministratorRole = "BILLING_MANAGER" // Represents a billing manager of the enterprise account.
)
EnterpriseAllowPrivateRepositoryForkingPolicyValue represents the possible values for the enterprise allow private repository forking policy value.
type EnterpriseAllowPrivateRepositoryForkingPolicyValue string
The possible values for the enterprise allow private repository forking policy value.
const (
EnterpriseAllowPrivateRepositoryForkingPolicyValueEnterpriseOrganizations EnterpriseAllowPrivateRepositoryForkingPolicyValue = "ENTERPRISE_ORGANIZATIONS" // Members can fork a repository to an organization within this enterprise.
EnterpriseAllowPrivateRepositoryForkingPolicyValueSameOrganization EnterpriseAllowPrivateRepositoryForkingPolicyValue = "SAME_ORGANIZATION" // Members can fork a repository only within the same organization (intra-org).
EnterpriseAllowPrivateRepositoryForkingPolicyValueSameOrganizationUserAccounts EnterpriseAllowPrivateRepositoryForkingPolicyValue = "SAME_ORGANIZATION_USER_ACCOUNTS" // Members can fork a repository to their user account or within the same organization.
EnterpriseAllowPrivateRepositoryForkingPolicyValueEnterpriseOrganizationsUserAccounts EnterpriseAllowPrivateRepositoryForkingPolicyValue = "ENTERPRISE_ORGANIZATIONS_USER_ACCOUNTS" // Members can fork a repository to their enterprise-managed user account or an organization inside this enterprise.
EnterpriseAllowPrivateRepositoryForkingPolicyValueUserAccounts EnterpriseAllowPrivateRepositoryForkingPolicyValue = "USER_ACCOUNTS" // Members can fork a repository to their user account.
EnterpriseAllowPrivateRepositoryForkingPolicyValueEverywhere EnterpriseAllowPrivateRepositoryForkingPolicyValue = "EVERYWHERE" // Members can fork a repository to their user account or an organization, either inside or outside of this enterprise.
)
EnterpriseDefaultRepositoryPermissionSettingValue represents the possible values for the enterprise base repository permission setting.
type EnterpriseDefaultRepositoryPermissionSettingValue string
The possible values for the enterprise base repository permission setting.
const (
EnterpriseDefaultRepositoryPermissionSettingValueNoPolicy EnterpriseDefaultRepositoryPermissionSettingValue = "NO_POLICY" // Organizations in the enterprise choose base repository permissions for their members.
EnterpriseDefaultRepositoryPermissionSettingValueAdmin EnterpriseDefaultRepositoryPermissionSettingValue = "ADMIN" // Organization members will be able to clone, pull, push, and add new collaborators to all organization repositories.
EnterpriseDefaultRepositoryPermissionSettingValueWrite EnterpriseDefaultRepositoryPermissionSettingValue = "WRITE" // Organization members will be able to clone, pull, and push all organization repositories.
EnterpriseDefaultRepositoryPermissionSettingValueRead EnterpriseDefaultRepositoryPermissionSettingValue = "READ" // Organization members will be able to clone and pull all organization repositories.
EnterpriseDefaultRepositoryPermissionSettingValueNone EnterpriseDefaultRepositoryPermissionSettingValue = "NONE" // Organization members will only be able to clone and pull public repositories.
)
EnterpriseEnabledDisabledSettingValue represents the possible values for an enabled/disabled enterprise setting.
type EnterpriseEnabledDisabledSettingValue string
The possible values for an enabled/disabled enterprise setting.
const (
EnterpriseEnabledDisabledSettingValueEnabled EnterpriseEnabledDisabledSettingValue = "ENABLED" // The setting is enabled for organizations in the enterprise.
EnterpriseEnabledDisabledSettingValueDisabled EnterpriseEnabledDisabledSettingValue = "DISABLED" // The setting is disabled for organizations in the enterprise.
EnterpriseEnabledDisabledSettingValueNoPolicy EnterpriseEnabledDisabledSettingValue = "NO_POLICY" // There is no policy set for organizations in the enterprise.
)
EnterpriseEnabledSettingValue represents the possible values for an enabled/no policy enterprise setting.
type EnterpriseEnabledSettingValue string
The possible values for an enabled/no policy enterprise setting.
const (
EnterpriseEnabledSettingValueEnabled EnterpriseEnabledSettingValue = "ENABLED" // The setting is enabled for organizations in the enterprise.
EnterpriseEnabledSettingValueNoPolicy EnterpriseEnabledSettingValue = "NO_POLICY" // There is no policy set for organizations in the enterprise.
)
EnterpriseMemberInvitationOrder represents ordering options for enterprise administrator invitation connections.
type EnterpriseMemberInvitationOrder struct {
// The field to order enterprise member invitations by. (Required.)
Field EnterpriseMemberInvitationOrderField `json:"field"`
// The ordering direction. (Required.)
Direction OrderDirection `json:"direction"`
}
EnterpriseMemberInvitationOrderField represents properties by which enterprise member invitation connections can be ordered.
type EnterpriseMemberInvitationOrderField string
Properties by which enterprise member invitation connections can be ordered.
const (
EnterpriseMemberInvitationOrderFieldCreatedAt EnterpriseMemberInvitationOrderField = "CREATED_AT" // Order enterprise member invitations by creation time.
)
EnterpriseMemberOrder represents ordering options for enterprise member connections.
type EnterpriseMemberOrder struct {
// The field to order enterprise members by. (Required.)
Field EnterpriseMemberOrderField `json:"field"`
// The ordering direction. (Required.)
Direction OrderDirection `json:"direction"`
}
EnterpriseMemberOrderField represents properties by which enterprise member connections can be ordered.
type EnterpriseMemberOrderField string
Properties by which enterprise member connections can be ordered.
const (
EnterpriseMemberOrderFieldLogin EnterpriseMemberOrderField = "LOGIN" // Order enterprise members by login.
EnterpriseMemberOrderFieldCreatedAt EnterpriseMemberOrderField = "CREATED_AT" // Order enterprise members by creation time.
)
EnterpriseMembersCanCreateRepositoriesSettingValue represents the possible values for the enterprise members can create repositories setting.
type EnterpriseMembersCanCreateRepositoriesSettingValue string
The possible values for the enterprise members can create repositories setting.
const (
EnterpriseMembersCanCreateRepositoriesSettingValueNoPolicy EnterpriseMembersCanCreateRepositoriesSettingValue = "NO_POLICY" // Organization owners choose whether to allow members to create repositories.
EnterpriseMembersCanCreateRepositoriesSettingValueAll EnterpriseMembersCanCreateRepositoriesSettingValue = "ALL" // Members will be able to create public and private repositories.
EnterpriseMembersCanCreateRepositoriesSettingValuePublic EnterpriseMembersCanCreateRepositoriesSettingValue = "PUBLIC" // Members will be able to create only public repositories.
EnterpriseMembersCanCreateRepositoriesSettingValuePrivate EnterpriseMembersCanCreateRepositoriesSettingValue = "PRIVATE" // Members will be able to create only private repositories.
EnterpriseMembersCanCreateRepositoriesSettingValueDisabled EnterpriseMembersCanCreateRepositoriesSettingValue = "DISABLED" // Members will not be able to create public or private repositories.
)
EnterpriseMembersCanMakePurchasesSettingValue represents the possible values for the members can make purchases setting.
type EnterpriseMembersCanMakePurchasesSettingValue string
The possible values for the members can make purchases setting.
const (
EnterpriseMembersCanMakePurchasesSettingValueEnabled EnterpriseMembersCanMakePurchasesSettingValue = "ENABLED" // The setting is enabled for organizations in the enterprise.
EnterpriseMembersCanMakePurchasesSettingValueDisabled EnterpriseMembersCanMakePurchasesSettingValue = "DISABLED" // The setting is disabled for organizations in the enterprise.
)
EnterpriseMembershipType represents the possible values we have for filtering Platform::Objects::User#enterprises.
type EnterpriseMembershipType string
The possible values we have for filtering Platform::Objects::User#enterprises.
const (
EnterpriseMembershipTypeAll EnterpriseMembershipType = "ALL" // Returns all enterprises in which the user is a member, admin, or billing manager.
EnterpriseMembershipTypeAdmin EnterpriseMembershipType = "ADMIN" // Returns all enterprises in which the user is an admin.
EnterpriseMembershipTypeBillingManager EnterpriseMembershipType = "BILLING_MANAGER" // Returns all enterprises in which the user is a billing manager.
EnterpriseMembershipTypeOrgMembership EnterpriseMembershipType = "ORG_MEMBERSHIP" // Returns all enterprises in which the user is a member of an org that is owned by the enterprise.
)
EnterpriseOrder represents ordering options for enterprises.
type EnterpriseOrder struct {
// The field to order enterprises by. (Required.)
Field EnterpriseOrderField `json:"field"`
// The ordering direction. (Required.)
Direction OrderDirection `json:"direction"`
}
EnterpriseOrderField represents properties by which enterprise connections can be ordered.
type EnterpriseOrderField string
Properties by which enterprise connections can be ordered.
const (
EnterpriseOrderFieldName EnterpriseOrderField = "NAME" // Order enterprises by name.
)
EnterpriseServerInstallationOrder represents ordering options for Enterprise Server installation connections.
type EnterpriseServerInstallationOrder struct {
// The field to order Enterprise Server installations by. (Required.)
Field EnterpriseServerInstallationOrderField `json:"field"`
// The ordering direction. (Required.)
Direction OrderDirection `json:"direction"`
}
EnterpriseServerInstallationOrderField represents properties by which Enterprise Server installation connections can be ordered.
type EnterpriseServerInstallationOrderField string
Properties by which Enterprise Server installation connections can be ordered.
const (
EnterpriseServerInstallationOrderFieldHostName EnterpriseServerInstallationOrderField = "HOST_NAME" // Order Enterprise Server installations by host name.
EnterpriseServerInstallationOrderFieldCustomerName EnterpriseServerInstallationOrderField = "CUSTOMER_NAME" // Order Enterprise Server installations by customer name.
EnterpriseServerInstallationOrderFieldCreatedAt EnterpriseServerInstallationOrderField = "CREATED_AT" // Order Enterprise Server installations by creation time.
)
EnterpriseServerUserAccountEmailOrder represents ordering options for Enterprise Server user account email connections.
type EnterpriseServerUserAccountEmailOrder struct {
// The field to order emails by. (Required.)
Field EnterpriseServerUserAccountEmailOrderField `json:"field"`
// The ordering direction. (Required.)
Direction OrderDirection `json:"direction"`
}
EnterpriseServerUserAccountEmailOrderField represents properties by which Enterprise Server user account email connections can be ordered.
type EnterpriseServerUserAccountEmailOrderField string
Properties by which Enterprise Server user account email connections can be ordered.
const (
EnterpriseServerUserAccountEmailOrderFieldEmail EnterpriseServerUserAccountEmailOrderField = "EMAIL" // Order emails by email.
)
EnterpriseServerUserAccountOrder represents ordering options for Enterprise Server user account connections.
type EnterpriseServerUserAccountOrder struct {
// The field to order user accounts by. (Required.)
Field EnterpriseServerUserAccountOrderField `json:"field"`
// The ordering direction. (Required.)
Direction OrderDirection `json:"direction"`
}
EnterpriseServerUserAccountOrderField represents properties by which Enterprise Server user account connections can be ordered.
type EnterpriseServerUserAccountOrderField string
Properties by which Enterprise Server user account connections can be ordered.
const (
EnterpriseServerUserAccountOrderFieldLogin EnterpriseServerUserAccountOrderField = "LOGIN" // Order user accounts by login.
EnterpriseServerUserAccountOrderFieldRemoteCreatedAt EnterpriseServerUserAccountOrderField = "REMOTE_CREATED_AT" // Order user accounts by creation time on the Enterprise Server installation.
)
EnterpriseServerUserAccountsUploadOrder represents ordering options for Enterprise Server user accounts upload connections.
type EnterpriseServerUserAccountsUploadOrder struct {
// The field to order user accounts uploads by. (Required.)
Field EnterpriseServerUserAccountsUploadOrderField `json:"field"`
// The ordering direction. (Required.)
Direction OrderDirection `json:"direction"`
}
EnterpriseServerUserAccountsUploadOrderField represents properties by which Enterprise Server user accounts upload connections can be ordered.
type EnterpriseServerUserAccountsUploadOrderField string
Properties by which Enterprise Server user accounts upload connections can be ordered.
const (
EnterpriseServerUserAccountsUploadOrderFieldCreatedAt EnterpriseServerUserAccountsUploadOrderField = "CREATED_AT" // Order user accounts uploads by creation time.
)
EnterpriseServerUserAccountsUploadSyncState represents synchronization state of the Enterprise Server user accounts upload.
type EnterpriseServerUserAccountsUploadSyncState string
Synchronization state of the Enterprise Server user accounts upload.
const (
EnterpriseServerUserAccountsUploadSyncStatePending EnterpriseServerUserAccountsUploadSyncState = "PENDING" // The synchronization of the upload is pending.
EnterpriseServerUserAccountsUploadSyncStateSuccess EnterpriseServerUserAccountsUploadSyncState = "SUCCESS" // The synchronization of the upload succeeded.
EnterpriseServerUserAccountsUploadSyncStateFailure EnterpriseServerUserAccountsUploadSyncState = "FAILURE" // The synchronization of the upload failed.
)
EnterpriseUserAccountMembershipRole represents the possible roles for enterprise membership.
type EnterpriseUserAccountMembershipRole string
The possible roles for enterprise membership.
const (
EnterpriseUserAccountMembershipRoleMember EnterpriseUserAccountMembershipRole = "MEMBER" // The user is a member of an organization in the enterprise.
EnterpriseUserAccountMembershipRoleOwner EnterpriseUserAccountMembershipRole = "OWNER" // The user is an owner of an organization in the enterprise.
EnterpriseUserAccountMembershipRoleUnaffiliated EnterpriseUserAccountMembershipRole = "UNAFFILIATED" // The user is not an owner of the enterprise, and not a member or owner of any organizations in the enterprise; only for EMU-enabled enterprises.
)
EnterpriseUserDeployment represents the possible GitHub Enterprise deployments where this user can exist.
type EnterpriseUserDeployment string
The possible GitHub Enterprise deployments where this user can exist.
const (
EnterpriseUserDeploymentCloud EnterpriseUserDeployment = "CLOUD" // The user is part of a GitHub Enterprise Cloud deployment.
EnterpriseUserDeploymentServer EnterpriseUserDeployment = "SERVER" // The user is part of a GitHub Enterprise Server deployment.
)
EnvironmentOrderField represents properties by which environments connections can be ordered.
type EnvironmentOrderField string
Properties by which environments connections can be ordered.
const (
EnvironmentOrderFieldName EnvironmentOrderField = "NAME" // Order environments by name.
)
EnvironmentPinnedFilterField represents properties by which environments connections can be ordered.
type EnvironmentPinnedFilterField string
Properties by which environments connections can be ordered.
const (
EnvironmentPinnedFilterFieldAll EnvironmentPinnedFilterField = "ALL" // All environments will be returned.
EnvironmentPinnedFilterFieldOnly EnvironmentPinnedFilterField = "ONLY" // Only pinned environment will be returned.
EnvironmentPinnedFilterFieldNone EnvironmentPinnedFilterField = "NONE" // Environments exclude pinned will be returned.
)
Environments represents ordering options for environments.
type Environments struct {
// The field to order environments by. (Required.)
Field EnvironmentOrderField `json:"field"`
// The direction in which to order environments by the specified field. (Required.)
Direction OrderDirection `json:"direction"`
}
FileAddition represents a command to add a file at the given path with the given contents as part of a commit. Any existing file at that that path will be replaced.
type FileAddition struct {
// The path in the repository where the file will be located. (Required.)
Path String `json:"path"`
// The base64 encoded contents of the file. (Required.)
Contents Base64String `json:"contents"`
}
FileChanges represents a description of a set of changes to a file tree to be made as part of a git commit, modeled as zero or more file `additions` and zero or more file `deletions`. Both fields are optional; omitting both will produce a commit with no file changes. `deletions` and `additions` describe changes to files identified by their path in the git tree using unix-style path separators, i.e. `/`. The root of a git tree is an empty string, so paths are not slash-prefixed. `path` values must be unique across all `additions` and `deletions` provided. Any duplication will result in a validation error. ### Encoding File contents must be provided in full for each `FileAddition`. The `contents` of a `FileAddition` must be encoded using RFC 4648 compliant base64, i.e. correct padding is required and no characters outside the standard alphabet may be used. Invalid base64 encoding will be rejected with a validation error. The encoded contents may be binary. For text files, no assumptions are made about the character encoding of the file contents (after base64 decoding). No charset transcoding or line-ending normalization will be performed; it is the client's responsibility to manage the character encoding of files they provide. However, for maximum compatibility we recommend using UTF-8 encoding and ensuring that all files in a repository use a consistent line-ending convention (`\n` or `\r\n`), and that all files end with a newline. ### Modeling file changes Each of the the five types of conceptual changes that can be made in a git commit can be described using the `FileChanges` type as follows: 1. New file addition: create file `hello world\n` at path `docs/README.txt`: { "additions" [ { "path": "docs/README.txt", "contents": base64encode("hello world\n") } ] } 2. Existing file modification: change existing `docs/README.txt` to have new content `new content here\n`: { "additions" [ { "path": "docs/README.txt", "contents": base64encode("new content here\n") } ] } 3. Existing file deletion: remove existing file `docs/README.txt`. Note that the path is required to exist -- specifying a path that does not exist on the given branch will abort the commit and return an error. { "deletions" [ { "path": "docs/README.txt" } ] } 4. File rename with no changes: rename `docs/README.txt` with previous content `hello world\n` to the same content at `newdocs/README.txt`: { "deletions" [ { "path": "docs/README.txt", } ], "additions" [ { "path": "newdocs/README.txt", "contents": base64encode("hello world\n") } ] } 5. File rename with changes: rename `docs/README.txt` with previous content `hello world\n` to a file at path `newdocs/README.txt` with content `new contents\n`: { "deletions" [ { "path": "docs/README.txt", } ], "additions" [ { "path": "newdocs/README.txt", "contents": base64encode("new contents\n") } ] }.
type FileChanges struct {
// Files to delete. (Optional.)
Deletions *[]FileDeletion `json:"deletions,omitempty"`
// File to add or change. (Optional.)
Additions *[]FileAddition `json:"additions,omitempty"`
}
FileDeletion represents a command to delete the file at the given path as part of a commit.
type FileDeletion struct {
// The path to delete. (Required.)
Path String `json:"path"`
}
FileExtensionRestrictionParametersInput represents prevent commits that include files with specified file extensions from being pushed to the commit graph. NOTE: This rule is in beta and subject to change.
type FileExtensionRestrictionParametersInput struct {
// The file extensions that are restricted from being pushed to the commit graph. (Required.)
RestrictedFileExtensions []String `json:"restrictedFileExtensions"`
}
FilePathRestrictionParametersInput represents prevent commits that include changes in specified file paths from being pushed to the commit graph. NOTE: This rule is in beta and subject to change.
type FilePathRestrictionParametersInput struct {
// The file paths that are restricted from being pushed to the commit graph. (Required.)
RestrictedFilePaths []String `json:"restrictedFilePaths"`
}
FileViewedState represents the possible viewed states of a file .
type FileViewedState string
The possible viewed states of a file .
const (
FileViewedStateDismissed FileViewedState = "DISMISSED" // The file has new changes since last viewed.
FileViewedStateViewed FileViewedState = "VIEWED" // The file has been marked as viewed.
FileViewedStateUnviewed FileViewedState = "UNVIEWED" // The file has not been marked as viewed.
)
Float represents signed double-precision fractional values as specified by IEEE 754.
type Float graphql.Float
func NewFloat(v Float) *Float
NewFloat is a helper to make a new *Float.
FollowOrganizationInput is an autogenerated input type of FollowOrganization.
type FollowOrganizationInput struct {
// ID of the organization to follow. (Required.)
OrganizationID ID `json:"organizationId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
FollowUserInput is an autogenerated input type of FollowUser.
type FollowUserInput struct {
// ID of the user to follow. (Required.)
UserID ID `json:"userId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
FundingPlatform represents the possible funding platforms for repository funding links.
type FundingPlatform string
The possible funding platforms for repository funding links.
const (
FundingPlatformGitHub FundingPlatform = "GITHUB" // GitHub funding platform.
FundingPlatformPatreon FundingPlatform = "PATREON" // Patreon funding platform.
FundingPlatformOpenCollective FundingPlatform = "OPEN_COLLECTIVE" // Open Collective funding platform.
FundingPlatformKoFi FundingPlatform = "KO_FI" // Ko-fi funding platform.
FundingPlatformTidelift FundingPlatform = "TIDELIFT" // Tidelift funding platform.
FundingPlatformCommunityBridge FundingPlatform = "COMMUNITY_BRIDGE" // Community Bridge funding platform.
FundingPlatformLiberapay FundingPlatform = "LIBERAPAY" // Liberapay funding platform.
FundingPlatformIssueHunt FundingPlatform = "ISSUEHUNT" // IssueHunt funding platform.
FundingPlatformLFXCrowdfunding FundingPlatform = "LFX_CROWDFUNDING" // LFX Crowdfunding funding platform.
FundingPlatformPolar FundingPlatform = "POLAR" // Polar funding platform.
FundingPlatformBuyMeACoffee FundingPlatform = "BUY_ME_A_COFFEE" // Buy Me a Coffee funding platform.
FundingPlatformCustom FundingPlatform = "CUSTOM" // Custom funding platform.
)
GistOrder represents ordering options for gist connections.
type GistOrder struct {
// The field to order repositories by. (Required.)
Field GistOrderField `json:"field"`
// The ordering direction. (Required.)
Direction OrderDirection `json:"direction"`
}
GistOrderField represents properties by which gist connections can be ordered.
type GistOrderField string
Properties by which gist connections can be ordered.
const (
GistOrderFieldCreatedAt GistOrderField = "CREATED_AT" // Order gists by creation time.
GistOrderFieldUpdatedAt GistOrderField = "UPDATED_AT" // Order gists by update time.
GistOrderFieldPushedAt GistOrderField = "PUSHED_AT" // Order gists by push time.
)
GistPrivacy represents the privacy of a Gist.
type GistPrivacy string
The privacy of a Gist.
const (
GistPrivacyPublic GistPrivacy = "PUBLIC" // Public.
GistPrivacySecret GistPrivacy = "SECRET" // Secret.
GistPrivacyAll GistPrivacy = "ALL" // Gists that are public and secret.
)
GitObjectID is a Git object ID. For example, "912ec1990bd09f8fc128c3fa6b59105085aabc03".
type GitObjectID string
func NewGitObjectID(v GitObjectID) *GitObjectID
NewGitObjectID is a helper to make a new *GitObjectID.
GitRefname is a fully qualified reference name (e.g., refs/heads/main).
type GitRefname string
func NewGitRefname(v GitRefname) *GitRefname
NewGitRefname is a helper to make a new *GitRefname.
GitSignatureState represents the state of a Git signature.
type GitSignatureState string
The state of a Git signature.
const (
GitSignatureStateValid GitSignatureState = "VALID" // Valid signature and verified by GitHub.
GitSignatureStateInvalid GitSignatureState = "INVALID" // Invalid signature.
GitSignatureStateMalformedSig GitSignatureState = "MALFORMED_SIG" // Malformed signature.
GitSignatureStateUnknownKey GitSignatureState = "UNKNOWN_KEY" // Key used for signing not known to GitHub.
GitSignatureStateBadEmail GitSignatureState = "BAD_EMAIL" // Invalid email used for signing.
GitSignatureStateUnverifiedEmail GitSignatureState = "UNVERIFIED_EMAIL" // Email used for signing unverified on GitHub.
GitSignatureStateNoUser GitSignatureState = "NO_USER" // Email used for signing not known to GitHub.
GitSignatureStateUnknownSigType GitSignatureState = "UNKNOWN_SIG_TYPE" // Unknown signature type.
GitSignatureStateUnsigned GitSignatureState = "UNSIGNED" // Unsigned.
GitSignatureState = "GPGVERIFY_UNAVAILABLE" // Internal error - the GPG verification service is unavailable at the moment.
GitSignatureStateGpgverifyError GitSignatureState = "GPGVERIFY_ERROR" // Internal error - the GPG verification service misbehaved.
GitSignatureStateNotSigningKey GitSignatureState = "NOT_SIGNING_KEY" // The usage flags for the key that signed this don't allow signing.
GitSignatureStateExpiredKey GitSignatureState = "EXPIRED_KEY" // Signing key expired.
GitSignatureStateOcspPending GitSignatureState = "OCSP_PENDING" // Valid signature, pending certificate revocation checking.
GitSignatureStateOcspError GitSignatureState = "OCSP_ERROR" // Valid signature, though certificate revocation check failed.
GitSignatureStateBadCert GitSignatureState = "BAD_CERT" // The signing certificate or its chain could not be verified.
GitSignatureStateOcspRevoked GitSignatureState = "OCSP_REVOKED" // One or more certificates in chain has been revoked.
)
GitTimestamp is an ISO-8601 encoded date. Unlike the DateTime type, GitTimestamp is not converted in UTC.
type GitTimestamp struct{ time.Time }
func NewGitTimestamp(v GitTimestamp) *GitTimestamp
NewGitTimestamp is a helper to make a new *GitTimestamp.
GrantEnterpriseOrganizationsMigratorRoleInput is an autogenerated input type of GrantEnterpriseOrganizationsMigratorRole.
type GrantEnterpriseOrganizationsMigratorRoleInput struct {
// The ID of the enterprise to which all organizations managed by it will be granted the migrator role. (Required.)
EnterpriseID ID `json:"enterpriseId"`
// The login of the user to grant the migrator role. (Required.)
Login String `json:"login"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
GrantMigratorRoleInput is an autogenerated input type of GrantMigratorRole.
type GrantMigratorRoleInput struct {
// The ID of the organization that the user/team belongs to. (Required.)
OrganizationID ID `json:"organizationId"`
// The user login or Team slug to grant the migrator role. (Required.)
Actor String `json:"actor"`
// Specifies the type of the actor, can be either USER or TEAM. (Required.)
ActorType ActorType `json:"actorType"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
HTML is a string containing HTML code.
type HTML string
func NewHTML(v HTML) *HTML
NewHTML is a helper to make a new *HTML.
ID represents a unique identifier that is Base64 obfuscated. It is often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "VXNlci0xMA==") or integer (such as 4) input value will be accepted as an ID.
type ID graphql.ID
func NewID(v ID) *ID
NewID is a helper to make a new *ID.
IdentityProviderConfigurationState represents the possible states in which authentication can be configured with an identity provider.
type IdentityProviderConfigurationState string
The possible states in which authentication can be configured with an identity provider.
const (
IdentityProviderConfigurationStateEnforced IdentityProviderConfigurationState = "ENFORCED" // Authentication with an identity provider is configured and enforced.
IdentityProviderConfigurationStateConfigured IdentityProviderConfigurationState = "CONFIGURED" // Authentication with an identity provider is configured but not enforced.
IdentityProviderConfigurationStateUnconfigured IdentityProviderConfigurationState = "UNCONFIGURED" // Authentication with an identity provider is not configured.
)
ImportProjectInput is an autogenerated input type of ImportProject.
type ImportProjectInput struct {
// The name of the Organization or User to create the Project under. (Required.)
OwnerName String `json:"ownerName"`
// The name of Project. (Required.)
Name String `json:"name"`
// A list of columns containing issues and pull requests. (Required.)
ColumnImports []ProjectColumnImport `json:"columnImports"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
// The description of Project. (Optional.)
Body *String `json:"body,omitempty"`
// Whether the Project is public or not. (Optional.)
Public *Boolean `json:"public,omitempty"`
}
Input represents one of the Input structs:
AbortQueuedMigrationsInput, AbortRepositoryMigrationInput, AcceptEnterpriseAdministratorInvitationInput, AcceptEnterpriseMemberInvitationInput, AcceptTopicSuggestionInput, AddAssigneesToAssignableInput, AddCommentInput, AddDiscussionCommentInput, AddDiscussionPollVoteInput, AddEnterpriseOrganizationMemberInput, AddEnterpriseSupportEntitlementInput, AddLabelsToLabelableInput, AddProjectCardInput, AddProjectColumnInput, AddProjectV2DraftIssueInput, AddProjectV2ItemByIdInput, AddPullRequestReviewCommentInput, AddPullRequestReviewInput, AddPullRequestReviewThreadInput, AddPullRequestReviewThreadReplyInput, AddReactionInput, AddStarInput, AddUpvoteInput, AddVerifiableDomainInput, ApproveDeploymentsInput, ApproveVerifiableDomainInput, ArchiveProjectV2ItemInput, ArchiveRepositoryInput, AuditLogOrder, BranchNamePatternParametersInput, BulkSponsorship, CancelEnterpriseAdminInvitationInput, CancelEnterpriseMemberInvitationInput, CancelSponsorshipInput, ChangeUserStatusInput, CheckAnnotationData, CheckAnnotationRange, CheckRunAction, CheckRunFilter, CheckRunOutput, CheckRunOutputImage, CheckSuiteAutoTriggerPreference, CheckSuiteFilter, ClearLabelsFromLabelableInput, ClearProjectV2ItemFieldValueInput, CloneProjectInput, CloneTemplateRepositoryInput, CloseDiscussionInput, CloseIssueInput, ClosePullRequestInput, CodeScanningParametersInput, CodeScanningToolInput, CommitAuthor, CommitAuthorEmailPatternParametersInput, CommitContributionOrder, CommitMessage, CommitMessagePatternParametersInput, CommittableBranch, CommitterEmailPatternParametersInput, ContributionOrder, ConvertProjectCardNoteToIssueInput, ConvertProjectV2DraftIssueItemToIssueInput, ConvertPullRequestToDraftInput, CopyProjectV2Input, CreateAttributionInvitationInput, CreateBranchProtectionRuleInput, CreateCheckRunInput, CreateCheckSuiteInput, CreateCommitOnBranchInput, CreateDeploymentInput, CreateDeploymentStatusInput, CreateDiscussionInput, CreateEnterpriseOrganizationInput, CreateEnvironmentInput, CreateIpAllowListEntryInput, CreateIssueInput, CreateLabelInput, CreateLinkedBranchInput, CreateMigrationSourceInput, CreateProjectInput, CreateProjectV2FieldInput, CreateProjectV2Input, CreateProjectV2StatusUpdateInput, CreatePullRequestInput, CreateRefInput, CreateRepositoryInput, CreateRepositoryRulesetInput, CreateSponsorsListingInput, CreateSponsorsTierInput, CreateSponsorshipInput, CreateSponsorshipsInput, CreateTeamDiscussionCommentInput, CreateTeamDiscussionInput, CreateUserListInput, DeclineTopicSuggestionInput, DeleteBranchProtectionRuleInput, DeleteDeploymentInput, DeleteDiscussionCommentInput, DeleteDiscussionInput, DeleteEnvironmentInput, DeleteIpAllowListEntryInput, DeleteIssueCommentInput, DeleteIssueInput, DeleteLabelInput, DeleteLinkedBranchInput, DeletePackageVersionInput, DeleteProjectCardInput, DeleteProjectColumnInput, DeleteProjectInput, DeleteProjectV2FieldInput, DeleteProjectV2Input, DeleteProjectV2ItemInput, DeleteProjectV2StatusUpdateInput, DeleteProjectV2WorkflowInput, DeletePullRequestReviewCommentInput, DeletePullRequestReviewInput, DeleteRefInput, DeleteRepositoryRulesetInput, DeleteTeamDiscussionCommentInput, DeleteTeamDiscussionInput, DeleteUserListInput, DeleteVerifiableDomainInput, DeploymentOrder, DequeuePullRequestInput, DisablePullRequestAutoMergeInput, DiscussionOrder, DiscussionPollOptionOrder, DismissPullRequestReviewInput, DismissRepositoryVulnerabilityAlertInput, DraftPullRequestReviewComment, DraftPullRequestReviewThread, EnablePullRequestAutoMergeInput, EnqueuePullRequestInput, EnterpriseAdministratorInvitationOrder, EnterpriseMemberInvitationOrder, EnterpriseMemberOrder, EnterpriseOrder, EnterpriseServerInstallationOrder, EnterpriseServerUserAccountEmailOrder, EnterpriseServerUserAccountOrder, EnterpriseServerUserAccountsUploadOrder, Environments, FileAddition, FileChanges, FileDeletion, FileExtensionRestrictionParametersInput, FilePathRestrictionParametersInput, FollowOrganizationInput, FollowUserInput, GistOrder, GrantEnterpriseOrganizationsMigratorRoleInput, GrantMigratorRoleInput, ImportProjectInput, InviteEnterpriseAdminInput, InviteEnterpriseMemberInput, IpAllowListEntryOrder, IssueCommentOrder, IssueFilters, IssueOrder, LabelOrder, LanguageOrder, LinkProjectV2ToRepositoryInput, LinkProjectV2ToTeamInput, LinkRepositoryToProjectInput, LockLockableInput, MannequinOrder, MarkDiscussionCommentAsAnswerInput, MarkFileAsViewedInput, MarkNotificationAsDoneInput, MarkProjectV2AsTemplateInput, MarkPullRequestReadyForReviewInput, MaxFilePathLengthParametersInput, MaxFileSizeParametersInput, MergeBranchInput, MergePullRequestInput, MergeQueueParametersInput, MilestoneOrder, MinimizeCommentInput, MoveProjectCardInput, MoveProjectColumnInput, OrgEnterpriseOwnerOrder, OrganizationOrder, PackageFileOrder, PackageOrder, PackageVersionOrder, PinEnvironmentInput, PinIssueInput, PinnedEnvironmentOrder, ProjectCardImport, ProjectColumnImport, ProjectOrder, ProjectV2Collaborator, ProjectV2FieldOrder, ProjectV2FieldValue, ProjectV2Filters, ProjectV2ItemFieldValueOrder, ProjectV2ItemOrder, ProjectV2Order, ProjectV2SingleSelectFieldOptionInput, ProjectV2StatusOrder, ProjectV2ViewOrder, ProjectV2WorkflowOrder, PropertyTargetDefinitionInput, PublishSponsorsTierInput, PullRequestOrder, PullRequestParametersInput, ReactionOrder, RefNameConditionTargetInput, RefOrder, RefUpdate, RegenerateEnterpriseIdentityProviderRecoveryCodesInput, RegenerateVerifiableDomainTokenInput, RejectDeploymentsInput, ReleaseOrder, RemoveAssigneesFromAssignableInput, RemoveEnterpriseAdminInput, RemoveEnterpriseIdentityProviderInput, RemoveEnterpriseMemberInput, RemoveEnterpriseOrganizationInput, RemoveEnterpriseSupportEntitlementInput, RemoveLabelsFromLabelableInput, RemoveOutsideCollaboratorInput, RemoveReactionInput, RemoveStarInput, RemoveUpvoteInput, ReopenDiscussionInput, ReopenIssueInput, ReopenPullRequestInput, ReorderEnvironmentInput, RepositoryIdConditionTargetInput, RepositoryInvitationOrder, RepositoryMigrationOrder, RepositoryNameConditionTargetInput, RepositoryOrder, RepositoryPropertyConditionTargetInput, RepositoryRuleConditionsInput, RepositoryRuleInput, RepositoryRuleOrder, RepositoryRulesetBypassActorInput, RequestReviewsInput, RequiredDeploymentsParametersInput, RequiredStatusCheckInput, RequiredStatusChecksParametersInput, RerequestCheckSuiteInput, ResolveReviewThreadInput, RetireSponsorsTierInput, RevertPullRequestInput, RevokeEnterpriseOrganizationsMigratorRoleInput, RevokeMigratorRoleInput, RuleParametersInput, SavedReplyOrder, SecurityAdvisoryIdentifierFilter, SecurityAdvisoryOrder, SecurityVulnerabilityOrder, SetEnterpriseIdentityProviderInput, SetOrganizationInteractionLimitInput, SetRepositoryInteractionLimitInput, SetUserInteractionLimitInput, SponsorAndLifetimeValueOrder, SponsorOrder, SponsorableOrder, SponsorsActivityOrder, SponsorsTierOrder, SponsorshipNewsletterOrder, SponsorshipOrder, StarOrder, StartOrganizationMigrationInput, StartRepositoryMigrationInput, StatusCheckConfigurationInput, SubmitPullRequestReviewInput, TagNamePatternParametersInput, TeamDiscussionCommentOrder, TeamDiscussionOrder, TeamMemberOrder, TeamOrder, TeamRepositoryOrder, TransferEnterpriseOrganizationInput, TransferIssueInput, UnarchiveProjectV2ItemInput, UnarchiveRepositoryInput, UnfollowOrganizationInput, UnfollowUserInput, UnlinkProjectV2FromRepositoryInput, UnlinkProjectV2FromTeamInput, UnlinkRepositoryFromProjectInput, UnlockLockableInput, UnmarkDiscussionCommentAsAnswerInput, UnmarkFileAsViewedInput, UnmarkIssueAsDuplicateInput, UnmarkProjectV2AsTemplateInput, UnminimizeCommentInput, UnpinIssueInput, UnresolveReviewThreadInput, UnsubscribeFromNotificationsInput, UpdateBranchProtectionRuleInput, UpdateCheckRunInput, UpdateCheckSuitePreferencesInput, UpdateDiscussionCommentInput, UpdateDiscussionInput, UpdateEnterpriseAdministratorRoleInput, UpdateEnterpriseAllowPrivateRepositoryForkingSettingInput, UpdateEnterpriseDefaultRepositoryPermissionSettingInput, UpdateEnterpriseMembersCanChangeRepositoryVisibilitySettingInput, UpdateEnterpriseMembersCanCreateRepositoriesSettingInput, UpdateEnterpriseMembersCanDeleteIssuesSettingInput, UpdateEnterpriseMembersCanDeleteRepositoriesSettingInput, UpdateEnterpriseMembersCanInviteCollaboratorsSettingInput, UpdateEnterpriseMembersCanMakePurchasesSettingInput, UpdateEnterpriseMembersCanUpdateProtectedBranchesSettingInput, UpdateEnterpriseMembersCanViewDependencyInsightsSettingInput, UpdateEnterpriseOrganizationProjectsSettingInput, UpdateEnterpriseOwnerOrganizationRoleInput, UpdateEnterpriseProfileInput, UpdateEnterpriseRepositoryProjectsSettingInput, UpdateEnterpriseTeamDiscussionsSettingInput, UpdateEnterpriseTwoFactorAuthenticationRequiredSettingInput, UpdateEnvironmentInput, UpdateIpAllowListEnabledSettingInput, UpdateIpAllowListEntryInput, UpdateIpAllowListForInstalledAppsEnabledSettingInput, UpdateIssueCommentInput, UpdateIssueInput, UpdateLabelInput, UpdateNotificationRestrictionSettingInput, UpdateOrganizationAllowPrivateRepositoryForkingSettingInput, UpdateOrganizationWebCommitSignoffSettingInput, UpdateParametersInput, UpdatePatreonSponsorabilityInput, UpdateProjectCardInput, UpdateProjectColumnInput, UpdateProjectInput, UpdateProjectV2CollaboratorsInput, UpdateProjectV2DraftIssueInput, UpdateProjectV2Input, UpdateProjectV2ItemFieldValueInput, UpdateProjectV2ItemPositionInput, UpdateProjectV2StatusUpdateInput, UpdatePullRequestBranchInput, UpdatePullRequestInput, UpdatePullRequestReviewCommentInput, UpdatePullRequestReviewInput, UpdateRefInput, UpdateRefsInput, UpdateRepositoryInput, UpdateRepositoryRulesetInput, UpdateRepositoryWebCommitSignoffSettingInput, UpdateSponsorshipPreferencesInput, UpdateSubscriptionInput, UpdateTeamDiscussionCommentInput, UpdateTeamDiscussionInput, UpdateTeamReviewAssignmentInput, UpdateTeamsRepositoryInput, UpdateTopicsInput, UpdateUserListInput, UpdateUserListsForItemInput, UserStatusOrder, VerifiableDomainOrder, VerifyVerifiableDomainInput, WorkflowFileReferenceInput, WorkflowRunOrder, WorkflowsParametersInput.
type Input interface{}
Int represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
type Int graphql.Int
func NewInt(v Int) *Int
NewInt is a helper to make a new *Int.
InviteEnterpriseAdminInput is an autogenerated input type of InviteEnterpriseAdmin.
type InviteEnterpriseAdminInput struct {
// The ID of the enterprise to which you want to invite an administrator. (Required.)
EnterpriseID ID `json:"enterpriseId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
// The login of a user to invite as an administrator. (Optional.)
Invitee *String `json:"invitee,omitempty"`
// The email of the person to invite as an administrator. (Optional.)
Email *String `json:"email,omitempty"`
// The role of the administrator. (Optional.)
Role *EnterpriseAdministratorRole `json:"role,omitempty"`
}
InviteEnterpriseMemberInput is an autogenerated input type of InviteEnterpriseMember.
type InviteEnterpriseMemberInput struct {
// The ID of the enterprise to which you want to invite an unaffiliated member. (Required.)
EnterpriseID ID `json:"enterpriseId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
// The login of a user to invite as an unaffiliated member. (Optional.)
Invitee *String `json:"invitee,omitempty"`
// The email of the person to invite as an unaffiliated member. (Optional.)
Email *String `json:"email,omitempty"`
}
IpAllowListEnabledSettingValue represents the possible values for the IP allow list enabled setting.
type IpAllowListEnabledSettingValue string
The possible values for the IP allow list enabled setting.
const (
IpAllowListEnabledSettingValueEnabled IpAllowListEnabledSettingValue = "ENABLED" // The setting is enabled for the owner.
IpAllowListEnabledSettingValueDisabled IpAllowListEnabledSettingValue = "DISABLED" // The setting is disabled for the owner.
)
IpAllowListEntryOrder represents ordering options for IP allow list entry connections.
type IpAllowListEntryOrder struct {
// The field to order IP allow list entries by. (Required.)
Field IpAllowListEntryOrderField `json:"field"`
// The ordering direction. (Required.)
Direction OrderDirection `json:"direction"`
}
IpAllowListEntryOrderField represents properties by which IP allow list entry connections can be ordered.
type IpAllowListEntryOrderField string
Properties by which IP allow list entry connections can be ordered.
const (
IpAllowListEntryOrderFieldCreatedAt IpAllowListEntryOrderField = "CREATED_AT" // Order IP allow list entries by creation time.
IpAllowListEntryOrderFieldAllowListValue IpAllowListEntryOrderField = "ALLOW_LIST_VALUE" // Order IP allow list entries by the allow list value.
)
IpAllowListForInstalledAppsEnabledSettingValue represents the possible values for the IP allow list configuration for installed GitHub Apps setting.
type IpAllowListForInstalledAppsEnabledSettingValue string
The possible values for the IP allow list configuration for installed GitHub Apps setting.
const (
IpAllowListForInstalledAppsEnabledSettingValueEnabled IpAllowListForInstalledAppsEnabledSettingValue = "ENABLED" // The setting is enabled for the owner.
IpAllowListForInstalledAppsEnabledSettingValueDisabled IpAllowListForInstalledAppsEnabledSettingValue = "DISABLED" // The setting is disabled for the owner.
)
IssueClosedStateReason represents the possible state reasons of a closed issue.
type IssueClosedStateReason string
The possible state reasons of a closed issue.
const (
IssueClosedStateReasonCompleted IssueClosedStateReason = "COMPLETED" // An issue that has been closed as completed.
IssueClosedStateReasonNotPlanned IssueClosedStateReason = "NOT_PLANNED" // An issue that has been closed as not planned.
)
IssueCommentOrder represents ways in which lists of issue comments can be ordered upon return.
type IssueCommentOrder struct {
// The field in which to order issue comments by. (Required.)
Field IssueCommentOrderField `json:"field"`
// The direction in which to order issue comments by the specified field. (Required.)
Direction OrderDirection `json:"direction"`
}
IssueCommentOrderField represents properties by which issue comment connections can be ordered.
type IssueCommentOrderField string
Properties by which issue comment connections can be ordered.
const (
IssueCommentOrderFieldUpdatedAt IssueCommentOrderField = "UPDATED_AT" // Order issue comments by update time.
)
IssueFilters represents ways in which to filter lists of issues.
type IssueFilters struct {
// List issues assigned to given name. Pass in `null` for issues with no assigned user, and `*` for issues assigned to any user. (Optional.)
Assignee *String `json:"assignee,omitempty"`
// List issues created by given name. (Optional.)
CreatedBy *String `json:"createdBy,omitempty"`
// List issues where the list of label names exist on the issue. (Optional.)
Labels *[]String `json:"labels,omitempty"`
// List issues where the given name is mentioned in the issue. (Optional.)
Mentioned *String `json:"mentioned,omitempty"`
// List issues by given milestone argument. If an string representation of an integer is passed, it should refer to a milestone by its database ID. Pass in `null` for issues with no milestone, and `*` for issues that are assigned to any milestone. (Optional.)
Milestone *String `json:"milestone,omitempty"`
// List issues by given milestone argument. If an string representation of an integer is passed, it should refer to a milestone by its number field. Pass in `null` for issues with no milestone, and `*` for issues that are assigned to any milestone. (Optional.)
MilestoneNumber *String `json:"milestoneNumber,omitempty"`
// List issues that have been updated at or after the given date. (Optional.)
Since *DateTime `json:"since,omitempty"`
// List issues filtered by the list of states given. (Optional.)
States *[]IssueState `json:"states,omitempty"`
// List issues subscribed to by viewer. (Optional.)
ViewerSubscribed *Boolean `json:"viewerSubscribed,omitempty"`
}
IssueOrder represents ways in which lists of issues can be ordered upon return.
type IssueOrder struct {
// The field in which to order issues by. (Required.)
Field IssueOrderField `json:"field"`
// The direction in which to order issues by the specified field. (Required.)
Direction OrderDirection `json:"direction"`
}
IssueOrderField represents properties by which issue connections can be ordered.
type IssueOrderField string
Properties by which issue connections can be ordered.
const (
IssueOrderFieldCreatedAt IssueOrderField = "CREATED_AT" // Order issues by creation time.
IssueOrderFieldUpdatedAt IssueOrderField = "UPDATED_AT" // Order issues by update time.
IssueOrderFieldComments IssueOrderField = "COMMENTS" // Order issues by comment count.
)
IssueState represents the possible states of an issue.
type IssueState string
The possible states of an issue.
const (
IssueStateOpen IssueState = "OPEN" // An issue that is still open.
IssueStateClosed IssueState = "CLOSED" // An issue that has been closed.
)
IssueStateReason represents the possible state reasons of an issue.
type IssueStateReason string
The possible state reasons of an issue.
const (
IssueStateReasonReopened IssueStateReason = "REOPENED" // An issue that has been reopened.
IssueStateReasonNotPlanned IssueStateReason = "NOT_PLANNED" // An issue that has been closed as not planned.
IssueStateReasonCompleted IssueStateReason = "COMPLETED" // An issue that has been closed as completed.
)
IssueTimelineItemsItemType represents the possible item types found in a timeline.
type IssueTimelineItemsItemType string
The possible item types found in a timeline.
const (
IssueTimelineItemsItemTypeIssueComment IssueTimelineItemsItemType = "ISSUE_COMMENT" // Represents a comment on an Issue.
IssueTimelineItemsItemTypeCrossReferencedEvent IssueTimelineItemsItemType = "CROSS_REFERENCED_EVENT" // Represents a mention made by one issue or pull request to another.
IssueTimelineItemsItemTypeAddedToProjectEvent IssueTimelineItemsItemType = "ADDED_TO_PROJECT_EVENT" // Represents a 'added_to_project' event on a given issue or pull request.
IssueTimelineItemsItemTypeAssignedEvent IssueTimelineItemsItemType = "ASSIGNED_EVENT" // Represents an 'assigned' event on any assignable object.
IssueTimelineItemsItemTypeClosedEvent IssueTimelineItemsItemType = "CLOSED_EVENT" // Represents a 'closed' event on any `Closable`.
IssueTimelineItemsItemTypeCommentDeletedEvent IssueTimelineItemsItemType = "COMMENT_DELETED_EVENT" // Represents a 'comment_deleted' event on a given issue or pull request.
IssueTimelineItemsItemTypeConnectedEvent IssueTimelineItemsItemType = "CONNECTED_EVENT" // Represents a 'connected' event on a given issue or pull request.
IssueTimelineItemsItemTypeConvertedNoteToIssueEvent IssueTimelineItemsItemType = "CONVERTED_NOTE_TO_ISSUE_EVENT" // Represents a 'converted_note_to_issue' event on a given issue or pull request.
IssueTimelineItemsItemTypeConvertedToDiscussionEvent IssueTimelineItemsItemType = "CONVERTED_TO_DISCUSSION_EVENT" // Represents a 'converted_to_discussion' event on a given issue.
IssueTimelineItemsItemTypeDemilestonedEvent IssueTimelineItemsItemType = "DEMILESTONED_EVENT" // Represents a 'demilestoned' event on a given issue or pull request.
IssueTimelineItemsItemTypeDisconnectedEvent IssueTimelineItemsItemType = "DISCONNECTED_EVENT" // Represents a 'disconnected' event on a given issue or pull request.
IssueTimelineItemsItemTypeLabeledEvent IssueTimelineItemsItemType = "LABELED_EVENT" // Represents a 'labeled' event on a given issue or pull request.
IssueTimelineItemsItemTypeLockedEvent IssueTimelineItemsItemType = "LOCKED_EVENT" // Represents a 'locked' event on a given issue or pull request.
IssueTimelineItemsItemTypeMarkedAsDuplicateEvent IssueTimelineItemsItemType = "MARKED_AS_DUPLICATE_EVENT" // Represents a 'marked_as_duplicate' event on a given issue or pull request.
IssueTimelineItemsItemTypeMentionedEvent IssueTimelineItemsItemType = "MENTIONED_EVENT" // Represents a 'mentioned' event on a given issue or pull request.
IssueTimelineItemsItemTypeMilestonedEvent IssueTimelineItemsItemType = "MILESTONED_EVENT" // Represents a 'milestoned' event on a given issue or pull request.
IssueTimelineItemsItemTypeMovedColumnsInProjectEvent IssueTimelineItemsItemType = "MOVED_COLUMNS_IN_PROJECT_EVENT" // Represents a 'moved_columns_in_project' event on a given issue or pull request.
IssueTimelineItemsItemTypePinnedEvent IssueTimelineItemsItemType = "PINNED_EVENT" // Represents a 'pinned' event on a given issue or pull request.
IssueTimelineItemsItemTypeReferencedEvent IssueTimelineItemsItemType = "REFERENCED_EVENT" // Represents a 'referenced' event on a given `ReferencedSubject`.
IssueTimelineItemsItemTypeRemovedFromProjectEvent IssueTimelineItemsItemType = "REMOVED_FROM_PROJECT_EVENT" // Represents a 'removed_from_project' event on a given issue or pull request.
IssueTimelineItemsItemTypeRenamedTitleEvent IssueTimelineItemsItemType = "RENAMED_TITLE_EVENT" // Represents a 'renamed' event on a given issue or pull request.
IssueTimelineItemsItemTypeReopenedEvent IssueTimelineItemsItemType = "REOPENED_EVENT" // Represents a 'reopened' event on any `Closable`.
IssueTimelineItemsItemTypeSubscribedEvent IssueTimelineItemsItemType = "SUBSCRIBED_EVENT" // Represents a 'subscribed' event on a given `Subscribable`.
IssueTimelineItemsItemTypeTransferredEvent IssueTimelineItemsItemType = "TRANSFERRED_EVENT" // Represents a 'transferred' event on a given issue or pull request.
IssueTimelineItemsItemTypeUnassignedEvent IssueTimelineItemsItemType = "UNASSIGNED_EVENT" // Represents an 'unassigned' event on any assignable object.
IssueTimelineItemsItemTypeUnlabeledEvent IssueTimelineItemsItemType = "UNLABELED_EVENT" // Represents an 'unlabeled' event on a given issue or pull request.
IssueTimelineItemsItemTypeUnlockedEvent IssueTimelineItemsItemType = "UNLOCKED_EVENT" // Represents an 'unlocked' event on a given issue or pull request.
IssueTimelineItemsItemTypeUserBlockedEvent IssueTimelineItemsItemType = "USER_BLOCKED_EVENT" // Represents a 'user_blocked' event on a given user.
IssueTimelineItemsItemTypeUnmarkedAsDuplicateEvent IssueTimelineItemsItemType = "UNMARKED_AS_DUPLICATE_EVENT" // Represents an 'unmarked_as_duplicate' event on a given issue or pull request.
IssueTimelineItemsItemTypeUnpinnedEvent IssueTimelineItemsItemType = "UNPINNED_EVENT" // Represents an 'unpinned' event on a given issue or pull request.
IssueTimelineItemsItemTypeUnsubscribedEvent IssueTimelineItemsItemType = "UNSUBSCRIBED_EVENT" // Represents an 'unsubscribed' event on a given `Subscribable`.
)
LabelOrder represents ways in which lists of labels can be ordered upon return.
type LabelOrder struct {
// The field in which to order labels by. (Required.)
Field LabelOrderField `json:"field"`
// The direction in which to order labels by the specified field. (Required.)
Direction OrderDirection `json:"direction"`
}
LabelOrderField represents properties by which label connections can be ordered.
type LabelOrderField string
Properties by which label connections can be ordered.
const (
LabelOrderFieldName LabelOrderField = "NAME" // Order labels by name.
LabelOrderFieldCreatedAt LabelOrderField = "CREATED_AT" // Order labels by creation time.
)
LanguageOrder represents ordering options for language connections.
type LanguageOrder struct {
// The field to order languages by. (Required.)
Field LanguageOrderField `json:"field"`
// The ordering direction. (Required.)
Direction OrderDirection `json:"direction"`
}
LanguageOrderField represents properties by which language connections can be ordered.
type LanguageOrderField string
Properties by which language connections can be ordered.
const (
LanguageOrderFieldSize LanguageOrderField = "SIZE" // Order languages by the size of all files containing the language.
)
LinkProjectV2ToRepositoryInput is an autogenerated input type of LinkProjectV2ToRepository.
type LinkProjectV2ToRepositoryInput struct {
// The ID of the project to link to the repository. (Required.)
ProjectID ID `json:"projectId"`
// The ID of the repository to link to the project. (Required.)
RepositoryID ID `json:"repositoryId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
LinkProjectV2ToTeamInput is an autogenerated input type of LinkProjectV2ToTeam.
type LinkProjectV2ToTeamInput struct {
// The ID of the project to link to the team. (Required.)
ProjectID ID `json:"projectId"`
// The ID of the team to link to the project. (Required.)
TeamID ID `json:"teamId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
LinkRepositoryToProjectInput is an autogenerated input type of LinkRepositoryToProject.
type LinkRepositoryToProjectInput struct {
// The ID of the Project to link to a Repository. (Required.)
ProjectID ID `json:"projectId"`
// The ID of the Repository to link to a Project. (Required.)
RepositoryID ID `json:"repositoryId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
LockLockableInput is an autogenerated input type of LockLockable.
type LockLockableInput struct {
// ID of the item to be locked. (Required.)
LockableID ID `json:"lockableId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
// A reason for why the item will be locked. (Optional.)
LockReason *LockReason `json:"lockReason,omitempty"`
}
LockReason represents the possible reasons that an issue or pull request was locked.
type LockReason string
The possible reasons that an issue or pull request was locked.
const (
LockReasonOffTopic LockReason = "OFF_TOPIC" // The issue or pull request was locked because the conversation was off-topic.
LockReasonTooHeated LockReason = "TOO_HEATED" // The issue or pull request was locked because the conversation was too heated.
LockReasonResolved LockReason = "RESOLVED" // The issue or pull request was locked because the conversation was resolved.
LockReasonSpam LockReason = "SPAM" // The issue or pull request was locked because the conversation was spam.
)
MannequinOrder represents ordering options for mannequins.
type MannequinOrder struct {
// The field to order mannequins by. (Required.)
Field MannequinOrderField `json:"field"`
// The ordering direction. (Required.)
Direction OrderDirection `json:"direction"`
}
MannequinOrderField represents properties by which mannequins can be ordered.
type MannequinOrderField string
Properties by which mannequins can be ordered.
const (
MannequinOrderFieldLogin MannequinOrderField = "LOGIN" // Order mannequins alphabetically by their source login.
MannequinOrderFieldCreatedAt MannequinOrderField = "CREATED_AT" // Order mannequins why when they were created.
)
MarkDiscussionCommentAsAnswerInput is an autogenerated input type of MarkDiscussionCommentAsAnswer.
type MarkDiscussionCommentAsAnswerInput struct {
// The Node ID of the discussion comment to mark as an answer. (Required.)
ID ID `json:"id"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
MarkFileAsViewedInput is an autogenerated input type of MarkFileAsViewed.
type MarkFileAsViewedInput struct {
// The Node ID of the pull request. (Required.)
PullRequestID ID `json:"pullRequestId"`
// The path of the file to mark as viewed. (Required.)
Path String `json:"path"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
MarkNotificationAsDoneInput is an autogenerated input type of MarkNotificationAsDone.
type MarkNotificationAsDoneInput struct {
// The NotificationThread id. (Required.)
ID ID `json:"id"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
MarkProjectV2AsTemplateInput is an autogenerated input type of MarkProjectV2AsTemplate.
type MarkProjectV2AsTemplateInput struct {
// The ID of the Project to mark as a template. (Required.)
ProjectID ID `json:"projectId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
MarkPullRequestReadyForReviewInput is an autogenerated input type of MarkPullRequestReadyForReview.
type MarkPullRequestReadyForReviewInput struct {
// ID of the pull request to be marked as ready for review. (Required.)
PullRequestID ID `json:"pullRequestId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
MaxFilePathLengthParametersInput represents prevent commits that include file paths that exceed a specified character limit from being pushed to the commit graph. NOTE: This rule is in beta and subject to change.
type MaxFilePathLengthParametersInput struct {
// The maximum amount of characters allowed in file paths. (Required.)
MaxFilePathLength Int `json:"maxFilePathLength"`
}
MaxFileSizeParametersInput represents prevent commits that exceed a specified file size limit from being pushed to the commit. NOTE: This rule is in beta and subject to change.
type MaxFileSizeParametersInput struct {
// The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS). (Required.)
MaxFileSize Int `json:"maxFileSize"`
}
MergeBranchInput is an autogenerated input type of MergeBranch.
type MergeBranchInput struct {
// The Node ID of the Repository containing the base branch that will be modified. (Required.)
RepositoryID ID `json:"repositoryId"`
// The name of the base branch that the provided head will be merged into. (Required.)
Base String `json:"base"`
// The head to merge into the base branch. This can be a branch name or a commit GitObjectID. (Required.)
Head String `json:"head"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
// Message to use for the merge commit. If omitted, a default will be used. (Optional.)
CommitMessage *String `json:"commitMessage,omitempty"`
// The email address to associate with this commit. (Optional.)
AuthorEmail *String `json:"authorEmail,omitempty"`
}
MergeCommitMessage represents the possible default commit messages for merges.
type MergeCommitMessage string
The possible default commit messages for merges.
const (
MergeCommitMessagePrTitle MergeCommitMessage = "PR_TITLE" // Default to the pull request's title.
MergeCommitMessagePrBody MergeCommitMessage = "PR_BODY" // Default to the pull request's body.
MergeCommitMessageBlank MergeCommitMessage = "BLANK" // Default to a blank commit message.
)
MergeCommitTitle represents the possible default commit titles for merges.
type MergeCommitTitle string
The possible default commit titles for merges.
const (
MergeCommitTitlePrTitle MergeCommitTitle = "PR_TITLE" // Default to the pull request's title.
MergeCommitTitleMergeMessage MergeCommitTitle = "MERGE_MESSAGE" // Default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
)
MergePullRequestInput is an autogenerated input type of MergePullRequest.
type MergePullRequestInput struct {
// ID of the pull request to be merged. (Required.)
PullRequestID ID `json:"pullRequestId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
// Commit headline to use for the merge commit; if omitted, a default message will be used. (Optional.)
CommitHeadline *String `json:"commitHeadline,omitempty"`
// Commit body to use for the merge commit; if omitted, a default message will be used. (Optional.)
CommitBody *String `json:"commitBody,omitempty"`
// OID that the pull request head ref must match to allow merge; if omitted, no check is performed. (Optional.)
ExpectedHeadOid *GitObjectID `json:"expectedHeadOid,omitempty"`
// The merge method to use. If omitted, defaults to 'MERGE'. (Optional.)
MergeMethod *PullRequestMergeMethod `json:"mergeMethod,omitempty"`
// The email address to associate with this merge. (Optional.)
AuthorEmail *String `json:"authorEmail,omitempty"`
}
MergeQueueEntryState represents the possible states for a merge queue entry.
type MergeQueueEntryState string
The possible states for a merge queue entry.
const (
MergeQueueEntryStateQueued MergeQueueEntryState = "QUEUED" // The entry is currently queued.
MergeQueueEntryStateAwaitingChecks MergeQueueEntryState = "AWAITING_CHECKS" // The entry is currently waiting for checks to pass.
MergeQueueEntryStateMergeable MergeQueueEntryState = "MERGEABLE" // The entry is currently mergeable.
MergeQueueEntryStateUnmergeable MergeQueueEntryState = "UNMERGEABLE" // The entry is currently unmergeable.
MergeQueueEntryStateLocked MergeQueueEntryState = "LOCKED" // The entry is currently locked.
)
MergeQueueGroupingStrategy represents when set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge.
type MergeQueueGroupingStrategy string
When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge.
const (
MergeQueueGroupingStrategyAllgreen MergeQueueGroupingStrategy = "ALLGREEN" // The merge commit created by merge queue for each PR in the group must pass all required checks to merge.
MergeQueueGroupingStrategyHeadgreen MergeQueueGroupingStrategy = "HEADGREEN" // Only the commit at the head of the merge group must pass its required checks to merge.
)
MergeQueueMergeMethod represents method to use when merging changes from queued pull requests.
type MergeQueueMergeMethod string
Method to use when merging changes from queued pull requests.
const (
MergeQueueMergeMethodMerge MergeQueueMergeMethod = "MERGE" // Merge commit.
MergeQueueMergeMethodSquash MergeQueueMergeMethod = "SQUASH" // Squash and merge.
MergeQueueMergeMethodRebase MergeQueueMergeMethod = "REBASE" // Rebase and merge.
)
MergeQueueMergingStrategy represents the possible merging strategies for a merge queue.
type MergeQueueMergingStrategy string
The possible merging strategies for a merge queue.
const (
MergeQueueMergingStrategyAllgreen MergeQueueMergingStrategy = "ALLGREEN" // Entries only allowed to merge if they are passing.
MergeQueueMergingStrategyHeadgreen MergeQueueMergingStrategy = "HEADGREEN" // Failing Entires are allowed to merge if they are with a passing entry.
)
MergeQueueParametersInput represents merges must be performed via a merge queue.
type MergeQueueParametersInput struct {
// Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed. (Required.)
CheckResponseTimeoutMinutes Int `json:"checkResponseTimeoutMinutes"`
// When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge. (Required.)
GroupingStrategy MergeQueueGroupingStrategy `json:"groupingStrategy"`
// Limit the number of queued pull requests requesting checks and workflow runs at the same time. (Required.)
MaxEntriesToBuild Int `json:"maxEntriesToBuild"`
// The maximum number of PRs that will be merged together in a group. (Required.)
MaxEntriesToMerge Int `json:"maxEntriesToMerge"`
// Method to use when merging changes from queued pull requests. (Required.)
MergeMethod MergeQueueMergeMethod `json:"mergeMethod"`
// The minimum number of PRs that will be merged together in a group. (Required.)
MinEntriesToMerge Int `json:"minEntriesToMerge"`
// The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged. (Required.)
MinEntriesToMergeWaitMinutes Int `json:"minEntriesToMergeWaitMinutes"`
}
MergeStateStatus represents detailed status information about a pull request merge.
type MergeStateStatus string
Detailed status information about a pull request merge.
const (
MergeStateStatusDirty MergeStateStatus = "DIRTY" // The merge commit cannot be cleanly created.
MergeStateStatusUnknown MergeStateStatus = "UNKNOWN" // The state cannot currently be determined.
MergeStateStatusBlocked MergeStateStatus = "BLOCKED" // The merge is blocked.
MergeStateStatusBehind MergeStateStatus = "BEHIND" // The head ref is out of date.
MergeStateStatusDraft MergeStateStatus = "DRAFT" // The merge is blocked due to the pull request being a draft.
MergeStateStatusUnstable MergeStateStatus = "UNSTABLE" // Mergeable with non-passing commit status.
MergeStateStatusHasHooks MergeStateStatus = "HAS_HOOKS" // Mergeable with passing commit status and pre-receive hooks.
MergeStateStatusClean MergeStateStatus = "CLEAN" // Mergeable and passing commit status.
)
MergeableState represents whether or not a PullRequest can be merged.
type MergeableState string
Whether or not a PullRequest can be merged.
const (
MergeableStateMergeable MergeableState = "MERGEABLE" // The pull request can be merged.
MergeableStateConflicting MergeableState = "CONFLICTING" // The pull request cannot be merged due to merge conflicts.
MergeableStateUnknown MergeableState = "UNKNOWN" // The mergeability of the pull request is still being calculated.
)
MigrationSourceType represents represents the different GitHub Enterprise Importer (GEI) migration sources.
type MigrationSourceType string
Represents the different GitHub Enterprise Importer (GEI) migration sources.
const (
MigrationSourceTypeAzureDevOps MigrationSourceType = "AZURE_DEVOPS" // An Azure DevOps migration source.
MigrationSourceTypeBitbucketServer MigrationSourceType = "BITBUCKET_SERVER" // A Bitbucket Server migration source.
MigrationSourceTypeGitHubArchive MigrationSourceType = "GITHUB_ARCHIVE" // A GitHub Migration API source.
)
MigrationState represents the GitHub Enterprise Importer (GEI) migration state.
type MigrationState string
The GitHub Enterprise Importer (GEI) migration state.
const (
MigrationStateNotStarted MigrationState = "NOT_STARTED" // The migration has not started.
MigrationStateQueued MigrationState = "QUEUED" // The migration has been queued.
MigrationStateInProgress MigrationState = "IN_PROGRESS" // The migration is in progress.
MigrationStateSucceeded MigrationState = "SUCCEEDED" // The migration has succeeded.
MigrationStateFailed MigrationState = "FAILED" // The migration has failed.
MigrationStatePendingValidation MigrationState = "PENDING_VALIDATION" // The migration needs to have its credentials validated.
MigrationStateFailedValidation MigrationState = "FAILED_VALIDATION" // The migration has invalid credentials.
)
MilestoneOrder represents ordering options for milestone connections.
type MilestoneOrder struct {
// The field to order milestones by. (Required.)
Field MilestoneOrderField `json:"field"`
// The ordering direction. (Required.)
Direction OrderDirection `json:"direction"`
}
MilestoneOrderField represents properties by which milestone connections can be ordered.
type MilestoneOrderField string
Properties by which milestone connections can be ordered.
const (
MilestoneOrderFieldDueDate MilestoneOrderField = "DUE_DATE" // Order milestones by when they are due.
MilestoneOrderFieldCreatedAt MilestoneOrderField = "CREATED_AT" // Order milestones by when they were created.
MilestoneOrderFieldUpdatedAt MilestoneOrderField = "UPDATED_AT" // Order milestones by when they were last updated.
MilestoneOrderFieldNumber MilestoneOrderField = "NUMBER" // Order milestones by their number.
)
MilestoneState represents the possible states of a milestone.
type MilestoneState string
The possible states of a milestone.
const (
MilestoneStateOpen MilestoneState = "OPEN" // A milestone that is still open.
MilestoneStateClosed MilestoneState = "CLOSED" // A milestone that has been closed.
)
MinimizeCommentInput is an autogenerated input type of MinimizeComment.
type MinimizeCommentInput struct {
// The Node ID of the subject to modify. (Required.)
SubjectID ID `json:"subjectId"`
// The classification of comment. (Required.)
Classifier ReportedContentClassifiers `json:"classifier"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
MoveProjectCardInput is an autogenerated input type of MoveProjectCard.
type MoveProjectCardInput struct {
// The id of the card to move. (Required.)
CardID ID `json:"cardId"`
// The id of the column to move it into. (Required.)
ColumnID ID `json:"columnId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
// Place the new card after the card with this id. Pass null to place it at the top. (Optional.)
AfterCardID *ID `json:"afterCardId,omitempty"`
}
MoveProjectColumnInput is an autogenerated input type of MoveProjectColumn.
type MoveProjectColumnInput struct {
// The id of the column to move. (Required.)
ColumnID ID `json:"columnId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
// Place the new column after the column with this id. Pass null to place it at the front. (Optional.)
AfterColumnID *ID `json:"afterColumnId,omitempty"`
}
NotificationRestrictionSettingValue represents the possible values for the notification restriction setting.
type NotificationRestrictionSettingValue string
The possible values for the notification restriction setting.
const (
NotificationRestrictionSettingValueEnabled NotificationRestrictionSettingValue = "ENABLED" // The setting is enabled for the owner.
NotificationRestrictionSettingValueDisabled NotificationRestrictionSettingValue = "DISABLED" // The setting is disabled for the owner.
)
OIDCProviderType represents the OIDC identity provider type.
type OIDCProviderType string
The OIDC identity provider type.
const (
OIDCProviderTypeAad OIDCProviderType = "AAD" // Azure Active Directory.
)
OauthApplicationCreateAuditEntryState represents the state of an OAuth application when it was created.
type OauthApplicationCreateAuditEntryState string
The state of an OAuth application when it was created.
const (
OauthApplicationCreateAuditEntryStateActive OauthApplicationCreateAuditEntryState = "ACTIVE" // The OAuth application was active and allowed to have OAuth Accesses.
OauthApplicationCreateAuditEntryStateSuspended OauthApplicationCreateAuditEntryState = "SUSPENDED" // The OAuth application was suspended from generating OAuth Accesses due to abuse or security concerns.
OauthApplicationCreateAuditEntryStatePendingDeletion OauthApplicationCreateAuditEntryState = "PENDING_DELETION" // The OAuth application was in the process of being deleted.
)
OperationType represents the corresponding operation type for the action.
type OperationType string
The corresponding operation type for the action.
const (
OperationTypeAccess OperationType = "ACCESS" // An existing resource was accessed.
OperationTypeAuthentication OperationType = "AUTHENTICATION" // A resource performed an authentication event.
OperationTypeCreate OperationType = "CREATE" // A new resource was created.
OperationTypeModify OperationType = "MODIFY" // An existing resource was modified.
OperationTypeRemove OperationType = "REMOVE" // An existing resource was removed.
OperationTypeRestore OperationType = "RESTORE" // An existing resource was restored.
OperationTypeTransfer OperationType = "TRANSFER" // An existing resource was transferred between multiple resources.
)
OrderDirection represents possible directions in which to order a list of items when provided an `orderBy` argument.
type OrderDirection string
Possible directions in which to order a list of items when provided an `orderBy` argument.
const (
OrderDirectionAsc OrderDirection = "ASC" // Specifies an ascending order for a given `orderBy` argument.
OrderDirectionDesc OrderDirection = "DESC" // Specifies a descending order for a given `orderBy` argument.
)
OrgAddMemberAuditEntryPermission represents the permissions available to members on an Organization.
type OrgAddMemberAuditEntryPermission string
The permissions available to members on an Organization.
const (
OrgAddMemberAuditEntryPermissionRead OrgAddMemberAuditEntryPermission = "READ" // Can read and clone repositories.
OrgAddMemberAuditEntryPermissionAdmin OrgAddMemberAuditEntryPermission = "ADMIN" // Can read, clone, push, and add collaborators to repositories.
)
OrgCreateAuditEntryBillingPlan represents the billing plans available for organizations.
type OrgCreateAuditEntryBillingPlan string
The billing plans available for organizations.
const (
OrgCreateAuditEntryBillingPlanFree OrgCreateAuditEntryBillingPlan = "FREE" // Free Plan.
OrgCreateAuditEntryBillingPlanBusiness OrgCreateAuditEntryBillingPlan = "BUSINESS" // Team Plan.
OrgCreateAuditEntryBillingPlanBusinessPlus OrgCreateAuditEntryBillingPlan = "BUSINESS_PLUS" // Enterprise Cloud Plan.
OrgCreateAuditEntryBillingPlanUnlimited OrgCreateAuditEntryBillingPlan = "UNLIMITED" // Legacy Unlimited Plan.
OrgCreateAuditEntryBillingPlanTieredPerSeat OrgCreateAuditEntryBillingPlan = "TIERED_PER_SEAT" // Tiered Per Seat Plan.
)
OrgEnterpriseOwnerOrder represents ordering options for an organization's enterprise owner connections.
type OrgEnterpriseOwnerOrder struct {
// The field to order enterprise owners by. (Required.)
Field OrgEnterpriseOwnerOrderField `json:"field"`
// The ordering direction. (Required.)
Direction OrderDirection `json:"direction"`
}
OrgEnterpriseOwnerOrderField represents properties by which enterprise owners can be ordered.
type OrgEnterpriseOwnerOrderField string
Properties by which enterprise owners can be ordered.
const (
OrgEnterpriseOwnerOrderFieldLogin OrgEnterpriseOwnerOrderField = "LOGIN" // Order enterprise owners by login.
)
OrgRemoveBillingManagerAuditEntryReason represents the reason a billing manager was removed from an Organization.
type OrgRemoveBillingManagerAuditEntryReason string
The reason a billing manager was removed from an Organization.
const (
OrgRemoveBillingManagerAuditEntryReasonTwoFactorRequirementNonCompliance OrgRemoveBillingManagerAuditEntryReason = "TWO_FACTOR_REQUIREMENT_NON_COMPLIANCE" // The organization required 2FA of its billing managers and this user did not have 2FA enabled.
OrgRemoveBillingManagerAuditEntryReasonSamlExternalIdentityMissing OrgRemoveBillingManagerAuditEntryReason = "SAML_EXTERNAL_IDENTITY_MISSING" // SAML external identity missing.
OrgRemoveBillingManagerAuditEntryReasonSamlSsoEnforcementRequiresExternalIdentity OrgRemoveBillingManagerAuditEntryReason = "SAML_SSO_ENFORCEMENT_REQUIRES_EXTERNAL_IDENTITY" // SAML SSO enforcement requires an external identity.
)
OrgRemoveMemberAuditEntryMembershipType represents the type of membership a user has with an Organization.
type OrgRemoveMemberAuditEntryMembershipType string
The type of membership a user has with an Organization.
const (
OrgRemoveMemberAuditEntryMembershipTypeSuspended OrgRemoveMemberAuditEntryMembershipType = "SUSPENDED" // A suspended member.
OrgRemoveMemberAuditEntryMembershipTypeDirectMember OrgRemoveMemberAuditEntryMembershipType = "DIRECT_MEMBER" // A direct member is a user that is a member of the Organization.
OrgRemoveMemberAuditEntryMembershipTypeAdmin OrgRemoveMemberAuditEntryMembershipType = "ADMIN" // Organization owners have full access and can change several settings, including the names of repositories that belong to the Organization and Owners team membership. In addition, organization owners can delete the organization and all of its repositories.
OrgRemoveMemberAuditEntryMembershipTypeBillingManager OrgRemoveMemberAuditEntryMembershipType = "BILLING_MANAGER" // A billing manager is a user who manages the billing settings for the Organization, such as updating payment information.
OrgRemoveMemberAuditEntryMembershipTypeUnaffiliated OrgRemoveMemberAuditEntryMembershipType = "UNAFFILIATED" // An unaffiliated collaborator is a person who is not a member of the Organization and does not have access to any repositories in the Organization.
OrgRemoveMemberAuditEntryMembershipTypeOutsideCollaborator OrgRemoveMemberAuditEntryMembershipType = "OUTSIDE_COLLABORATOR" // An outside collaborator is a person who isn't explicitly a member of the Organization, but who has Read, Write, or Admin permissions to one or more repositories in the organization.
)
OrgRemoveMemberAuditEntryReason represents the reason a member was removed from an Organization.
type OrgRemoveMemberAuditEntryReason string
The reason a member was removed from an Organization.
const (
OrgRemoveMemberAuditEntryReasonTwoFactorRequirementNonCompliance OrgRemoveMemberAuditEntryReason = "TWO_FACTOR_REQUIREMENT_NON_COMPLIANCE" // The organization required 2FA of its billing managers and this user did not have 2FA enabled.
OrgRemoveMemberAuditEntryReasonSamlExternalIdentityMissing OrgRemoveMemberAuditEntryReason = "SAML_EXTERNAL_IDENTITY_MISSING" // SAML external identity missing.
OrgRemoveMemberAuditEntryReasonSamlSsoEnforcementRequiresExternalIdentity OrgRemoveMemberAuditEntryReason = "SAML_SSO_ENFORCEMENT_REQUIRES_EXTERNAL_IDENTITY" // SAML SSO enforcement requires an external identity.
OrgRemoveMemberAuditEntryReasonUserAccountDeleted OrgRemoveMemberAuditEntryReason = "USER_ACCOUNT_DELETED" // User account has been deleted.
OrgRemoveMemberAuditEntryReasonTwoFactorAccountRecovery OrgRemoveMemberAuditEntryReason = "TWO_FACTOR_ACCOUNT_RECOVERY" // User was removed from organization during account recovery.
)
OrgRemoveOutsideCollaboratorAuditEntryMembershipType represents the type of membership a user has with an Organization.
type OrgRemoveOutsideCollaboratorAuditEntryMembershipType string
The type of membership a user has with an Organization.
const (
OrgRemoveOutsideCollaboratorAuditEntryMembershipTypeOutsideCollaborator OrgRemoveOutsideCollaboratorAuditEntryMembershipType = "OUTSIDE_COLLABORATOR" // An outside collaborator is a person who isn't explicitly a member of the Organization, but who has Read, Write, or Admin permissions to one or more repositories in the organization.
OrgRemoveOutsideCollaboratorAuditEntryMembershipTypeUnaffiliated OrgRemoveOutsideCollaboratorAuditEntryMembershipType = "UNAFFILIATED" // An unaffiliated collaborator is a person who is not a member of the Organization and does not have access to any repositories in the organization.
OrgRemoveOutsideCollaboratorAuditEntryMembershipTypeBillingManager OrgRemoveOutsideCollaboratorAuditEntryMembershipType = "BILLING_MANAGER" // A billing manager is a user who manages the billing settings for the Organization, such as updating payment information.
)
OrgRemoveOutsideCollaboratorAuditEntryReason represents the reason an outside collaborator was removed from an Organization.
type OrgRemoveOutsideCollaboratorAuditEntryReason string
The reason an outside collaborator was removed from an Organization.
const (
OrgRemoveOutsideCollaboratorAuditEntryReasonTwoFactorRequirementNonCompliance OrgRemoveOutsideCollaboratorAuditEntryReason = "TWO_FACTOR_REQUIREMENT_NON_COMPLIANCE" // The organization required 2FA of its billing managers and this user did not have 2FA enabled.
OrgRemoveOutsideCollaboratorAuditEntryReasonSamlExternalIdentityMissing OrgRemoveOutsideCollaboratorAuditEntryReason = "SAML_EXTERNAL_IDENTITY_MISSING" // SAML external identity missing.
)
OrgUpdateDefaultRepositoryPermissionAuditEntryPermission represents the default permission a repository can have in an Organization.
type OrgUpdateDefaultRepositoryPermissionAuditEntryPermission string
The default permission a repository can have in an Organization.
const (
OrgUpdateDefaultRepositoryPermissionAuditEntryPermissionRead OrgUpdateDefaultRepositoryPermissionAuditEntryPermission = "READ" // Can read and clone repositories.
OrgUpdateDefaultRepositoryPermissionAuditEntryPermissionWrite OrgUpdateDefaultRepositoryPermissionAuditEntryPermission = "WRITE" // Can read, clone and push to repositories.
OrgUpdateDefaultRepositoryPermissionAuditEntryPermissionAdmin OrgUpdateDefaultRepositoryPermissionAuditEntryPermission = "ADMIN" // Can read, clone, push, and add collaborators to repositories.
OrgUpdateDefaultRepositoryPermissionAuditEntryPermissionNone OrgUpdateDefaultRepositoryPermissionAuditEntryPermission = "NONE" // No default permission value.
)
OrgUpdateMemberAuditEntryPermission represents the permissions available to members on an Organization.
type OrgUpdateMemberAuditEntryPermission string
The permissions available to members on an Organization.
const (
OrgUpdateMemberAuditEntryPermissionRead OrgUpdateMemberAuditEntryPermission = "READ" // Can read and clone repositories.
OrgUpdateMemberAuditEntryPermissionAdmin OrgUpdateMemberAuditEntryPermission = "ADMIN" // Can read, clone, push, and add collaborators to repositories.
)
OrgUpdateMemberRepositoryCreationPermissionAuditEntryVisibility represents the permissions available for repository creation on an Organization.
type OrgUpdateMemberRepositoryCreationPermissionAuditEntryVisibility string
The permissions available for repository creation on an Organization.
const (
OrgUpdateMemberRepositoryCreationPermissionAuditEntryVisibilityAll OrgUpdateMemberRepositoryCreationPermissionAuditEntryVisibility = "ALL" // All organization members are restricted from creating any repositories.
OrgUpdateMemberRepositoryCreationPermissionAuditEntryVisibilityPublic OrgUpdateMemberRepositoryCreationPermissionAuditEntryVisibility = "PUBLIC" // All organization members are restricted from creating public repositories.
OrgUpdateMemberRepositoryCreationPermissionAuditEntryVisibilityNone OrgUpdateMemberRepositoryCreationPermissionAuditEntryVisibility = "NONE" // All organization members are allowed to create any repositories.
OrgUpdateMemberRepositoryCreationPermissionAuditEntryVisibilityPrivate OrgUpdateMemberRepositoryCreationPermissionAuditEntryVisibility = "PRIVATE" // All organization members are restricted from creating private repositories.
OrgUpdateMemberRepositoryCreationPermissionAuditEntryVisibilityInternal OrgUpdateMemberRepositoryCreationPermissionAuditEntryVisibility = "INTERNAL" // All organization members are restricted from creating internal repositories.
OrgUpdateMemberRepositoryCreationPermissionAuditEntryVisibilityPublicInternal OrgUpdateMemberRepositoryCreationPermissionAuditEntryVisibility = "PUBLIC_INTERNAL" // All organization members are restricted from creating public or internal repositories.
OrgUpdateMemberRepositoryCreationPermissionAuditEntryVisibilityPrivateInternal OrgUpdateMemberRepositoryCreationPermissionAuditEntryVisibility = "PRIVATE_INTERNAL" // All organization members are restricted from creating private or internal repositories.
OrgUpdateMemberRepositoryCreationPermissionAuditEntryVisibilityPublicPrivate OrgUpdateMemberRepositoryCreationPermissionAuditEntryVisibility = "PUBLIC_PRIVATE" // All organization members are restricted from creating public or private repositories.
)
OrganizationInvitationRole represents the possible organization invitation roles.
type OrganizationInvitationRole string
The possible organization invitation roles.
const (
OrganizationInvitationRoleDirectMember OrganizationInvitationRole = "DIRECT_MEMBER" // The user is invited to be a direct member of the organization.
OrganizationInvitationRoleAdmin OrganizationInvitationRole = "ADMIN" // The user is invited to be an admin of the organization.
OrganizationInvitationRoleBillingManager OrganizationInvitationRole = "BILLING_MANAGER" // The user is invited to be a billing manager of the organization.
OrganizationInvitationRoleReinstate OrganizationInvitationRole = "REINSTATE" // The user's previous role will be reinstated.
)
OrganizationInvitationSource represents the possible organization invitation sources.
type OrganizationInvitationSource string
The possible organization invitation sources.
const (
OrganizationInvitationSourceUnknown OrganizationInvitationSource = "UNKNOWN" // The invitation was sent before this feature was added.
OrganizationInvitationSourceMember OrganizationInvitationSource = "MEMBER" // The invitation was created from the web interface or from API.
OrganizationInvitationSourceSCIM OrganizationInvitationSource = "SCIM" // The invitation was created from SCIM.
)
OrganizationInvitationType represents the possible organization invitation types.
type OrganizationInvitationType string
The possible organization invitation types.
const (
OrganizationInvitationTypeUser OrganizationInvitationType = "USER" // The invitation was to an existing user.
OrganizationInvitationTypeEmail OrganizationInvitationType = "EMAIL" // The invitation was to an email address.
)
OrganizationMemberRole represents the possible roles within an organization for its members.
type OrganizationMemberRole string
The possible roles within an organization for its members.
const (
OrganizationMemberRoleMember OrganizationMemberRole = "MEMBER" // The user is a member of the organization.
OrganizationMemberRoleAdmin OrganizationMemberRole = "ADMIN" // The user is an administrator of the organization.
)
OrganizationMembersCanCreateRepositoriesSettingValue represents the possible values for the members can create repositories setting on an organization.
type OrganizationMembersCanCreateRepositoriesSettingValue string
The possible values for the members can create repositories setting on an organization.
const (
OrganizationMembersCanCreateRepositoriesSettingValueAll OrganizationMembersCanCreateRepositoriesSettingValue = "ALL" // Members will be able to create public and private repositories.
OrganizationMembersCanCreateRepositoriesSettingValuePrivate OrganizationMembersCanCreateRepositoriesSettingValue = "PRIVATE" // Members will be able to create only private repositories.
OrganizationMembersCanCreateRepositoriesSettingValueInternal OrganizationMembersCanCreateRepositoriesSettingValue = "INTERNAL" // Members will be able to create only internal repositories.
OrganizationMembersCanCreateRepositoriesSettingValueDisabled OrganizationMembersCanCreateRepositoriesSettingValue = "DISABLED" // Members will not be able to create public or private repositories.
)
OrganizationMigrationState represents the Octoshift Organization migration state.
type OrganizationMigrationState string
The Octoshift Organization migration state.
const (
OrganizationMigrationStateNotStarted OrganizationMigrationState = "NOT_STARTED" // The Octoshift migration has not started.
OrganizationMigrationStateQueued OrganizationMigrationState = "QUEUED" // The Octoshift migration has been queued.
OrganizationMigrationStateInProgress OrganizationMigrationState = "IN_PROGRESS" // The Octoshift migration is in progress.
OrganizationMigrationStatePreRepoMigration OrganizationMigrationState = "PRE_REPO_MIGRATION" // The Octoshift migration is performing pre repository migrations.
OrganizationMigrationStateRepoMigration OrganizationMigrationState = "REPO_MIGRATION" // The Octoshift org migration is performing repository migrations.
OrganizationMigrationStatePostRepoMigration OrganizationMigrationState = "POST_REPO_MIGRATION" // The Octoshift migration is performing post repository migrations.
OrganizationMigrationStateSucceeded OrganizationMigrationState = "SUCCEEDED" // The Octoshift migration has succeeded.
OrganizationMigrationStateFailed OrganizationMigrationState = "FAILED" // The Octoshift migration has failed.
OrganizationMigrationStatePendingValidation OrganizationMigrationState = "PENDING_VALIDATION" // The Octoshift migration needs to have its credentials validated.
OrganizationMigrationStateFailedValidation OrganizationMigrationState = "FAILED_VALIDATION" // The Octoshift migration has invalid credentials.
)
OrganizationOrder represents ordering options for organization connections.
type OrganizationOrder struct {
// The field to order organizations by. (Required.)
Field OrganizationOrderField `json:"field"`
// The ordering direction. (Required.)
Direction OrderDirection `json:"direction"`
}
OrganizationOrderField represents properties by which organization connections can be ordered.
type OrganizationOrderField string
Properties by which organization connections can be ordered.
const (
OrganizationOrderFieldCreatedAt OrganizationOrderField = "CREATED_AT" // Order organizations by creation time.
OrganizationOrderFieldLogin OrganizationOrderField = "LOGIN" // Order organizations by login.
)
PackageFileOrder represents ways in which lists of package files can be ordered upon return.
type PackageFileOrder struct {
// The field in which to order package files by. (Optional.)
Field *PackageFileOrderField `json:"field,omitempty"`
// The direction in which to order package files by the specified field. (Optional.)
Direction *OrderDirection `json:"direction,omitempty"`
}
PackageFileOrderField represents properties by which package file connections can be ordered.
type PackageFileOrderField string
Properties by which package file connections can be ordered.
const (
PackageFileOrderFieldCreatedAt PackageFileOrderField = "CREATED_AT" // Order package files by creation time.
)
PackageOrder represents ways in which lists of packages can be ordered upon return.
type PackageOrder struct {
// The field in which to order packages by. (Optional.)
Field *PackageOrderField `json:"field,omitempty"`
// The direction in which to order packages by the specified field. (Optional.)
Direction *OrderDirection `json:"direction,omitempty"`
}
PackageOrderField represents properties by which package connections can be ordered.
type PackageOrderField string
Properties by which package connections can be ordered.
const (
PackageOrderFieldCreatedAt PackageOrderField = "CREATED_AT" // Order packages by creation time.
)
PackageType represents the possible types of a package.
type PackageType string
The possible types of a package.
const (
PackageTypeNpm PackageType = "NPM" // An npm package.
PackageTypeRubygems PackageType = "RUBYGEMS" // A rubygems package.
PackageTypeMaven PackageType = "MAVEN" // A maven package.
PackageTypeDocker PackageType = "DOCKER" // A docker image.
PackageTypeDebian PackageType = "DEBIAN" // A debian package.
PackageTypeNuget PackageType = "NUGET" // A nuget package.
PackageTypePypi PackageType = "PYPI" // A python package.
)
PackageVersionOrder represents ways in which lists of package versions can be ordered upon return.
type PackageVersionOrder struct {
// The field in which to order package versions by. (Optional.)
Field *PackageVersionOrderField `json:"field,omitempty"`
// The direction in which to order package versions by the specified field. (Optional.)
Direction *OrderDirection `json:"direction,omitempty"`
}
PackageVersionOrderField represents properties by which package version connections can be ordered.
type PackageVersionOrderField string
Properties by which package version connections can be ordered.
const (
PackageVersionOrderFieldCreatedAt PackageVersionOrderField = "CREATED_AT" // Order package versions by creation time.
)
PatchStatus represents the possible types of patch statuses.
type PatchStatus string
The possible types of patch statuses.
const (
PatchStatusAdded PatchStatus = "ADDED" // The file was added. Git status 'A'.
PatchStatusDeleted PatchStatus = "DELETED" // The file was deleted. Git status 'D'.
PatchStatusRenamed PatchStatus = "RENAMED" // The file was renamed. Git status 'R'.
PatchStatusCopied PatchStatus = "COPIED" // The file was copied. Git status 'C'.
PatchStatusModified PatchStatus = "MODIFIED" // The file's contents were changed. Git status 'M'.
PatchStatusChanged PatchStatus = "CHANGED" // The file's type was changed. Git status 'T'.
)
PinEnvironmentInput is an autogenerated input type of PinEnvironment.
type PinEnvironmentInput struct {
// The ID of the environment to modify. (Required.)
EnvironmentID ID `json:"environmentId"`
// The desired state of the environment. If true, environment will be pinned. If false, it will be unpinned. (Required.)
Pinned Boolean `json:"pinned"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
PinIssueInput is an autogenerated input type of PinIssue.
type PinIssueInput struct {
// The ID of the issue to be pinned. (Required.)
IssueID ID `json:"issueId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
PinnableItemType represents represents items that can be pinned to a profile page or dashboard.
type PinnableItemType string
Represents items that can be pinned to a profile page or dashboard.
const (
PinnableItemTypeRepository PinnableItemType = "REPOSITORY" // A repository.
PinnableItemTypeGist PinnableItemType = "GIST" // A gist.
PinnableItemTypeIssue PinnableItemType = "ISSUE" // An issue.
PinnableItemTypeProject PinnableItemType = "PROJECT" // A project.
PinnableItemTypePullRequest PinnableItemType = "PULL_REQUEST" // A pull request.
PinnableItemTypeUser PinnableItemType = "USER" // A user.
PinnableItemTypeOrganization PinnableItemType = "ORGANIZATION" // An organization.
PinnableItemTypeTeam PinnableItemType = "TEAM" // A team.
)
PinnedDiscussionGradient represents preconfigured gradients that may be used to style discussions pinned within a repository.
type PinnedDiscussionGradient string
Preconfigured gradients that may be used to style discussions pinned within a repository.
const (
PinnedDiscussionGradientRedOrange PinnedDiscussionGradient = "RED_ORANGE" // A gradient of red to orange.
PinnedDiscussionGradientBlueMint PinnedDiscussionGradient = "BLUE_MINT" // A gradient of blue to mint.
PinnedDiscussionGradientBluePurple PinnedDiscussionGradient = "BLUE_PURPLE" // A gradient of blue to purple.
PinnedDiscussionGradientPinkBlue PinnedDiscussionGradient = "PINK_BLUE" // A gradient of pink to blue.
PinnedDiscussionGradientPurpleCoral PinnedDiscussionGradient = "PURPLE_CORAL" // A gradient of purple to coral.
)
PinnedDiscussionPattern represents preconfigured background patterns that may be used to style discussions pinned within a repository.
type PinnedDiscussionPattern string
Preconfigured background patterns that may be used to style discussions pinned within a repository.
const (
PinnedDiscussionPatternDotFill PinnedDiscussionPattern = "DOT_FILL" // A solid dot pattern.
PinnedDiscussionPatternPlus PinnedDiscussionPattern = "PLUS" // A plus sign pattern.
PinnedDiscussionPatternZap PinnedDiscussionPattern = "ZAP" // A lightning bolt pattern.
PinnedDiscussionPatternChevronUp PinnedDiscussionPattern = "CHEVRON_UP" // An upward-facing chevron pattern.
PinnedDiscussionPatternDot PinnedDiscussionPattern = "DOT" // A hollow dot pattern.
PinnedDiscussionPatternHeartFill PinnedDiscussionPattern = "HEART_FILL" // A heart pattern.
)
PinnedEnvironmentOrder represents ordering options for pinned environments.
type PinnedEnvironmentOrder struct {
// The field to order pinned environments by. (Required.)
Field PinnedEnvironmentOrderField `json:"field"`
// The direction in which to order pinned environments by the specified field. (Required.)
Direction OrderDirection `json:"direction"`
}
PinnedEnvironmentOrderField represents properties by which pinned environments connections can be ordered.
type PinnedEnvironmentOrderField string
Properties by which pinned environments connections can be ordered.
const (
PinnedEnvironmentOrderFieldPosition PinnedEnvironmentOrderField = "POSITION" // Order pinned environments by position.
)
ProjectCardArchivedState represents the possible archived states of a project card.
type ProjectCardArchivedState string
The possible archived states of a project card.
const (
ProjectCardArchivedStateArchived ProjectCardArchivedState = "ARCHIVED" // A project card that is archived.
ProjectCardArchivedStateNotArchived ProjectCardArchivedState = "NOT_ARCHIVED" // A project card that is not archived.
)
ProjectCardImport represents an issue or PR and its owning repository to be used in a project card.
type ProjectCardImport struct {
// Repository name with owner (owner/repository). (Required.)
Repository String `json:"repository"`
// The issue or pull request number. (Required.)
Number Int `json:"number"`
}
ProjectCardState represents various content states of a ProjectCard.
type ProjectCardState string
Various content states of a ProjectCard.
const (
ProjectCardStateContentOnly ProjectCardState = "CONTENT_ONLY" // The card has content only.
ProjectCardStateNoteOnly ProjectCardState = "NOTE_ONLY" // The card has a note only.
ProjectCardStateRedacted ProjectCardState = "REDACTED" // The card is redacted.
)
ProjectColumnImport represents a project column and a list of its issues and PRs.
type ProjectColumnImport struct {
// The name of the column. (Required.)
ColumnName String `json:"columnName"`
// The position of the column, starting from 0. (Required.)
Position Int `json:"position"`
// A list of issues and pull requests in the column. (Optional.)
Issues *[]ProjectCardImport `json:"issues,omitempty"`
}
ProjectColumnPurpose represents the semantic purpose of the column - todo, in progress, or done.
type ProjectColumnPurpose string
The semantic purpose of the column - todo, in progress, or done.
const (
ProjectColumnPurposeTodo ProjectColumnPurpose = "TODO" // The column contains cards still to be worked on.
ProjectColumnPurposeInProgress ProjectColumnPurpose = "IN_PROGRESS" // The column contains cards which are currently being worked on.
ProjectColumnPurposeDone ProjectColumnPurpose = "DONE" // The column contains cards which are complete.
)
ProjectOrder represents ways in which lists of projects can be ordered upon return.
type ProjectOrder struct {
// The field in which to order projects by. (Required.)
Field ProjectOrderField `json:"field"`
// The direction in which to order projects by the specified field. (Required.)
Direction OrderDirection `json:"direction"`
}
ProjectOrderField represents properties by which project connections can be ordered.
type ProjectOrderField string
Properties by which project connections can be ordered.
const (
ProjectOrderFieldCreatedAt ProjectOrderField = "CREATED_AT" // Order projects by creation time.
ProjectOrderFieldUpdatedAt ProjectOrderField = "UPDATED_AT" // Order projects by update time.
ProjectOrderFieldName ProjectOrderField = "NAME" // Order projects by name.
)
ProjectState represents state of the project; either 'open' or 'closed'.
type ProjectState string
State of the project; either 'open' or 'closed'.
const (
ProjectStateOpen ProjectState = "OPEN" // The project is open.
ProjectStateClosed ProjectState = "CLOSED" // The project is closed.
)
ProjectTemplate represents gitHub-provided templates for Projects.
type ProjectTemplate string
GitHub-provided templates for Projects.
const (
ProjectTemplateBasicKanban ProjectTemplate = "BASIC_KANBAN" // Create a board with columns for To do, In progress and Done.
ProjectTemplateAutomatedKanbanV2 ProjectTemplate = "AUTOMATED_KANBAN_V2" // Create a board with v2 triggers to automatically move cards across To do, In progress and Done columns.
ProjectTemplateAutomatedReviewsKanban ProjectTemplate = "AUTOMATED_REVIEWS_KANBAN" // Create a board with triggers to automatically move cards across columns with review automation.
ProjectTemplateBugTriage ProjectTemplate = "BUG_TRIAGE" // Create a board to triage and prioritize bugs with To do, priority, and Done columns.
)
ProjectV2Collaborator represents a collaborator to update on a project. Only one of the userId or teamId should be provided.
type ProjectV2Collaborator struct {
// The role to grant the collaborator. (Required.)
Role ProjectV2Roles `json:"role"`
// The ID of the user as a collaborator. (Optional.)
UserID *ID `json:"userId,omitempty"`
// The ID of the team as a collaborator. (Optional.)
TeamID *ID `json:"teamId,omitempty"`
}
ProjectV2CustomFieldType represents the type of a project field.
type ProjectV2CustomFieldType string
The type of a project field.
const (
ProjectV2CustomFieldTypeText ProjectV2CustomFieldType = "TEXT" // Text.
ProjectV2CustomFieldTypeSingleSelect ProjectV2CustomFieldType = "SINGLE_SELECT" // Single Select.
ProjectV2CustomFieldTypeNumber ProjectV2CustomFieldType = "NUMBER" // Number.
ProjectV2CustomFieldTypeDate ProjectV2CustomFieldType = "DATE" // Date.
)
ProjectV2FieldOrder represents ordering options for project v2 field connections.
type ProjectV2FieldOrder struct {
// The field to order the project v2 fields by. (Required.)
Field ProjectV2FieldOrderField `json:"field"`
// The ordering direction. (Required.)
Direction OrderDirection `json:"direction"`
}
ProjectV2FieldOrderField represents properties by which project v2 field connections can be ordered.
type ProjectV2FieldOrderField string
Properties by which project v2 field connections can be ordered.
const (
ProjectV2FieldOrderFieldPosition ProjectV2FieldOrderField = "POSITION" // Order project v2 fields by position.
ProjectV2FieldOrderFieldCreatedAt ProjectV2FieldOrderField = "CREATED_AT" // Order project v2 fields by creation time.
ProjectV2FieldOrderFieldName ProjectV2FieldOrderField = "NAME" // Order project v2 fields by name.
)
ProjectV2FieldType represents the type of a project field.
type ProjectV2FieldType string
The type of a project field.
const (
ProjectV2FieldTypeAssignees ProjectV2FieldType = "ASSIGNEES" // Assignees.
ProjectV2FieldTypeLinkedPullRequests ProjectV2FieldType = "LINKED_PULL_REQUESTS" // Linked Pull Requests.
ProjectV2FieldTypeReviewers ProjectV2FieldType = "REVIEWERS" // Reviewers.
ProjectV2FieldTypeLabels ProjectV2FieldType = "LABELS" // Labels.
ProjectV2FieldTypeMilestone ProjectV2FieldType = "MILESTONE" // Milestone.
ProjectV2FieldTypeRepository ProjectV2FieldType = "REPOSITORY" // Repository.
ProjectV2FieldTypeTitle ProjectV2FieldType = "TITLE" // Title.
ProjectV2FieldTypeText ProjectV2FieldType = "TEXT" // Text.
ProjectV2FieldTypeSingleSelect ProjectV2FieldType = "SINGLE_SELECT" // Single Select.
ProjectV2FieldTypeNumber ProjectV2FieldType = "NUMBER" // Number.
ProjectV2FieldTypeDate ProjectV2FieldType = "DATE" // Date.
ProjectV2FieldTypeIteration ProjectV2FieldType = "ITERATION" // Iteration.
ProjectV2FieldTypeTracks ProjectV2FieldType = "TRACKS" // Tracks.
ProjectV2FieldTypeTrackedBy ProjectV2FieldType = "TRACKED_BY" // Tracked by.
)
ProjectV2FieldValue represents the values that can be used to update a field of an item inside a Project. Only 1 value can be updated at a time.
type ProjectV2FieldValue struct {
// The text to set on the field. (Optional.)
Text *String `json:"text,omitempty"`
// The number to set on the field. (Optional.)
Number *Float `json:"number,omitempty"`
// The ISO 8601 date to set on the field. (Optional.)
Date *Date `json:"date,omitempty"`
// The id of the single select option to set on the field. (Optional.)
SingleSelectOptionID *String `json:"singleSelectOptionId,omitempty"`
// The id of the iteration to set on the field. (Optional.)
IterationID *String `json:"iterationId,omitempty"`
}
ProjectV2Filters represents ways in which to filter lists of projects.
type ProjectV2Filters struct {
// List project v2 filtered by the state given. (Optional.)
State *ProjectV2State `json:"state,omitempty"`
}
ProjectV2ItemFieldValueOrder represents ordering options for project v2 item field value connections.
type ProjectV2ItemFieldValueOrder struct {
// The field to order the project v2 item field values by. (Required.)
Field ProjectV2ItemFieldValueOrderField `json:"field"`
// The ordering direction. (Required.)
Direction OrderDirection `json:"direction"`
}
ProjectV2ItemFieldValueOrderField represents properties by which project v2 item field value connections can be ordered.
type ProjectV2ItemFieldValueOrderField string
Properties by which project v2 item field value connections can be ordered.
const (
ProjectV2ItemFieldValueOrderFieldPosition ProjectV2ItemFieldValueOrderField = "POSITION" // Order project v2 item field values by the their position in the project.
)
ProjectV2ItemOrder represents ordering options for project v2 item connections.
type ProjectV2ItemOrder struct {
// The field to order the project v2 items by. (Required.)
Field ProjectV2ItemOrderField `json:"field"`
// The ordering direction. (Required.)
Direction OrderDirection `json:"direction"`
}
ProjectV2ItemOrderField represents properties by which project v2 item connections can be ordered.
type ProjectV2ItemOrderField string
Properties by which project v2 item connections can be ordered.
const (
ProjectV2ItemOrderFieldPosition ProjectV2ItemOrderField = "POSITION" // Order project v2 items by the their position in the project.
)
ProjectV2ItemType represents the type of a project item.
type ProjectV2ItemType string
The type of a project item.
const (
ProjectV2ItemTypeIssue ProjectV2ItemType = "ISSUE" // Issue.
ProjectV2ItemTypePullRequest ProjectV2ItemType = "PULL_REQUEST" // Pull Request.
ProjectV2ItemTypeDraftIssue ProjectV2ItemType = "DRAFT_ISSUE" // Draft Issue.
ProjectV2ItemTypeRedacted ProjectV2ItemType = "REDACTED" // Redacted Item.
)
ProjectV2Order represents ways in which lists of projects can be ordered upon return.
type ProjectV2Order struct {
// The field in which to order projects by. (Required.)
Field ProjectV2OrderField `json:"field"`
// The direction in which to order projects by the specified field. (Required.)
Direction OrderDirection `json:"direction"`
}
ProjectV2OrderField represents properties by which projects can be ordered.
type ProjectV2OrderField string
Properties by which projects can be ordered.
const (
ProjectV2OrderFieldTitle ProjectV2OrderField = "TITLE" // The project's title.
ProjectV2OrderFieldNumber ProjectV2OrderField = "NUMBER" // The project's number.
ProjectV2OrderFieldUpdatedAt ProjectV2OrderField = "UPDATED_AT" // The project's date and time of update.
ProjectV2OrderFieldCreatedAt ProjectV2OrderField = "CREATED_AT" // The project's date and time of creation.
)
ProjectV2PermissionLevel represents the possible roles of a collaborator on a project.
type ProjectV2PermissionLevel string
The possible roles of a collaborator on a project.
const (
ProjectV2PermissionLevelRead ProjectV2PermissionLevel = "READ" // The collaborator can view the project.
ProjectV2PermissionLevelWrite ProjectV2PermissionLevel = "WRITE" // The collaborator can view and edit the project.
ProjectV2PermissionLevelAdmin ProjectV2PermissionLevel = "ADMIN" // The collaborator can view, edit, and maange the settings of the project.
)
ProjectV2Roles represents the possible roles of a collaborator on a project.
type ProjectV2Roles string
The possible roles of a collaborator on a project.
const (
ProjectV2RolesNone ProjectV2Roles = "NONE" // The collaborator has no direct access to the project.
ProjectV2RolesReader ProjectV2Roles = "READER" // The collaborator can view the project.
ProjectV2RolesWriter ProjectV2Roles = "WRITER" // The collaborator can view and edit the project.
ProjectV2RolesAdmin ProjectV2Roles = "ADMIN" // The collaborator can view, edit, and maange the settings of the project.
)
ProjectV2SingleSelectFieldOptionColor represents the display color of a single-select field option.
type ProjectV2SingleSelectFieldOptionColor string
The display color of a single-select field option.
const (
ProjectV2SingleSelectFieldOptionColorGray ProjectV2SingleSelectFieldOptionColor = "GRAY" // GRAY.
ProjectV2SingleSelectFieldOptionColorBlue ProjectV2SingleSelectFieldOptionColor = "BLUE" // BLUE.
ProjectV2SingleSelectFieldOptionColorGreen ProjectV2SingleSelectFieldOptionColor = "GREEN" // GREEN.
ProjectV2SingleSelectFieldOptionColorYellow ProjectV2SingleSelectFieldOptionColor = "YELLOW" // YELLOW.
ProjectV2SingleSelectFieldOptionColorOrange ProjectV2SingleSelectFieldOptionColor = "ORANGE" // ORANGE.
ProjectV2SingleSelectFieldOptionColorRed ProjectV2SingleSelectFieldOptionColor = "RED" // RED.
ProjectV2SingleSelectFieldOptionColorPink ProjectV2SingleSelectFieldOptionColor = "PINK" // PINK.
ProjectV2SingleSelectFieldOptionColorPurple ProjectV2SingleSelectFieldOptionColor = "PURPLE" // PURPLE.
)
ProjectV2SingleSelectFieldOptionInput represents represents a single select field option.
type ProjectV2SingleSelectFieldOptionInput struct {
// The name of the option. (Required.)
Name String `json:"name"`
// The display color of the option. (Required.)
Color ProjectV2SingleSelectFieldOptionColor `json:"color"`
// The description text of the option. (Required.)
Description String `json:"description"`
}
ProjectV2State represents the possible states of a project v2.
type ProjectV2State string
The possible states of a project v2.
const (
ProjectV2StateOpen ProjectV2State = "OPEN" // A project v2 that is still open.
ProjectV2StateClosed ProjectV2State = "CLOSED" // A project v2 that has been closed.
)
ProjectV2StatusOrder represents ways in which project v2 status updates can be ordered.
type ProjectV2StatusOrder struct {
// The field by which to order nodes. (Required.)
Field ProjectV2StatusUpdateOrderField `json:"field"`
// The direction in which to order nodes. (Required.)
Direction OrderDirection `json:"direction"`
}
ProjectV2StatusUpdateOrderField represents properties by which project v2 status updates can be ordered.
type ProjectV2StatusUpdateOrderField string
Properties by which project v2 status updates can be ordered.
const (
ProjectV2StatusUpdateOrderFieldCreatedAt ProjectV2StatusUpdateOrderField = "CREATED_AT" // Allows chronological ordering of project v2 status updates.
)
ProjectV2StatusUpdateStatus represents the possible statuses of a project v2.
type ProjectV2StatusUpdateStatus string
The possible statuses of a project v2.
const (
ProjectV2StatusUpdateStatusInactive ProjectV2StatusUpdateStatus = "INACTIVE" // A project v2 that is inactive.
ProjectV2StatusUpdateStatusOnTrack ProjectV2StatusUpdateStatus = "ON_TRACK" // A project v2 that is on track with no risks.
ProjectV2StatusUpdateStatusAtRisk ProjectV2StatusUpdateStatus = "AT_RISK" // A project v2 that is at risk and encountering some challenges.
ProjectV2StatusUpdateStatusOffTrack ProjectV2StatusUpdateStatus = "OFF_TRACK" // A project v2 that is off track and needs attention.
ProjectV2StatusUpdateStatusComplete ProjectV2StatusUpdateStatus = "COMPLETE" // A project v2 that is complete.
)
ProjectV2ViewLayout represents the layout of a project v2 view.
type ProjectV2ViewLayout string
The layout of a project v2 view.
const (
ProjectV2ViewLayoutBoardLayout ProjectV2ViewLayout = "BOARD_LAYOUT" // Board layout.
ProjectV2ViewLayoutTableLayout ProjectV2ViewLayout = "TABLE_LAYOUT" // Table layout.
ProjectV2ViewLayoutRoadmapLayout ProjectV2ViewLayout = "ROADMAP_LAYOUT" // Roadmap layout.
)
ProjectV2ViewOrder represents ordering options for project v2 view connections.
type ProjectV2ViewOrder struct {
// The field to order the project v2 views by. (Required.)
Field ProjectV2ViewOrderField `json:"field"`
// The ordering direction. (Required.)
Direction OrderDirection `json:"direction"`
}
ProjectV2ViewOrderField represents properties by which project v2 view connections can be ordered.
type ProjectV2ViewOrderField string
Properties by which project v2 view connections can be ordered.
const (
ProjectV2ViewOrderFieldPosition ProjectV2ViewOrderField = "POSITION" // Order project v2 views by position.
ProjectV2ViewOrderFieldCreatedAt ProjectV2ViewOrderField = "CREATED_AT" // Order project v2 views by creation time.
ProjectV2ViewOrderFieldName ProjectV2ViewOrderField = "NAME" // Order project v2 views by name.
)
ProjectV2WorkflowOrder represents ordering options for project v2 workflows connections.
type ProjectV2WorkflowOrder struct {
// The field to order the project v2 workflows by. (Required.)
Field ProjectV2WorkflowsOrderField `json:"field"`
// The ordering direction. (Required.)
Direction OrderDirection `json:"direction"`
}
ProjectV2WorkflowsOrderField represents properties by which project workflows can be ordered.
type ProjectV2WorkflowsOrderField string
Properties by which project workflows can be ordered.
const (
ProjectV2WorkflowsOrderFieldName ProjectV2WorkflowsOrderField = "NAME" // The name of the workflow.
ProjectV2WorkflowsOrderFieldNumber ProjectV2WorkflowsOrderField = "NUMBER" // The number of the workflow.
ProjectV2WorkflowsOrderFieldUpdatedAt ProjectV2WorkflowsOrderField = "UPDATED_AT" // The date and time of the workflow update.
ProjectV2WorkflowsOrderFieldCreatedAt ProjectV2WorkflowsOrderField = "CREATED_AT" // The date and time of the workflow creation.
)
PropertyTargetDefinitionInput represents a property that must match.
type PropertyTargetDefinitionInput struct {
// The name of the property. (Required.)
Name String `json:"name"`
// The values to match for. (Required.)
PropertyValues []String `json:"propertyValues"`
// The source of the property. Choose 'custom' or 'system'. Defaults to 'custom' if not specified. (Optional.)
Source *String `json:"source,omitempty"`
}
PublishSponsorsTierInput is an autogenerated input type of PublishSponsorsTier.
type PublishSponsorsTierInput struct {
// The ID of the draft tier to publish. (Required.)
TierID ID `json:"tierId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
PullRequestBranchUpdateMethod represents the possible methods for updating a pull request's head branch with the base branch.
type PullRequestBranchUpdateMethod string
The possible methods for updating a pull request's head branch with the base branch.
const (
PullRequestBranchUpdateMethodMerge PullRequestBranchUpdateMethod = "MERGE" // Update branch via merge.
PullRequestBranchUpdateMethodRebase PullRequestBranchUpdateMethod = "REBASE" // Update branch via rebase.
)
PullRequestMergeMethod represents represents available types of methods to use when merging a pull request.
type PullRequestMergeMethod string
Represents available types of methods to use when merging a pull request.
const (
PullRequestMergeMethodMerge PullRequestMergeMethod = "MERGE" // Add all commits from the head branch to the base branch with a merge commit.
PullRequestMergeMethodSquash PullRequestMergeMethod = "SQUASH" // Combine all commits from the head branch into a single commit in the base branch.
PullRequestMergeMethodRebase PullRequestMergeMethod = "REBASE" // Add all commits from the head branch onto the base branch individually.
)
PullRequestOrder represents ways in which lists of issues can be ordered upon return.
type PullRequestOrder struct {
// The field in which to order pull requests by. (Required.)
Field PullRequestOrderField `json:"field"`
// The direction in which to order pull requests by the specified field. (Required.)
Direction OrderDirection `json:"direction"`
}
PullRequestOrderField represents properties by which pull_requests connections can be ordered.
type PullRequestOrderField string
Properties by which pull_requests connections can be ordered.
const (
PullRequestOrderFieldCreatedAt PullRequestOrderField = "CREATED_AT" // Order pull_requests by creation time.
PullRequestOrderFieldUpdatedAt PullRequestOrderField = "UPDATED_AT" // Order pull_requests by update time.
)
PullRequestParametersInput represents require all commits be made to a non-target branch and submitted via a pull request before they can be merged.
type PullRequestParametersInput struct {
// New, reviewable commits pushed will dismiss previous pull request review approvals. (Required.)
DismissStaleReviewsOnPush Boolean `json:"dismissStaleReviewsOnPush"`
// Require an approving review in pull requests that modify files that have a designated code owner. (Required.)
RequireCodeOwnerReview Boolean `json:"requireCodeOwnerReview"`
// Whether the most recent reviewable push must be approved by someone other than the person who pushed it. (Required.)
RequireLastPushApproval Boolean `json:"requireLastPushApproval"`
// The number of approving reviews that are required before a pull request can be merged. (Required.)
RequiredApprovingReviewCount Int `json:"requiredApprovingReviewCount"`
// All conversations on code must be resolved before a pull request can be merged. (Required.)
RequiredReviewThreadResolution Boolean `json:"requiredReviewThreadResolution"`
}
PullRequestReviewCommentState represents the possible states of a pull request review comment.
type PullRequestReviewCommentState string
The possible states of a pull request review comment.
const (
PullRequestReviewCommentStatePending PullRequestReviewCommentState = "PENDING" // A comment that is part of a pending review.
PullRequestReviewCommentStateSubmitted PullRequestReviewCommentState = "SUBMITTED" // A comment that is part of a submitted review.
)
PullRequestReviewDecision represents the review status of a pull request.
type PullRequestReviewDecision string
The review status of a pull request.
const (
PullRequestReviewDecisionChangesRequested PullRequestReviewDecision = "CHANGES_REQUESTED" // Changes have been requested on the pull request.
PullRequestReviewDecisionApproved PullRequestReviewDecision = "APPROVED" // The pull request has received an approving review.
PullRequestReviewDecisionReviewRequired PullRequestReviewDecision = "REVIEW_REQUIRED" // A review is required before the pull request can be merged.
)
PullRequestReviewEvent represents the possible events to perform on a pull request review.
type PullRequestReviewEvent string
The possible events to perform on a pull request review.
const (
PullRequestReviewEventComment PullRequestReviewEvent = "COMMENT" // Submit general feedback without explicit approval.
PullRequestReviewEventApprove PullRequestReviewEvent = "APPROVE" // Submit feedback and approve merging these changes.
PullRequestReviewEventRequestChanges PullRequestReviewEvent = "REQUEST_CHANGES" // Submit feedback that must be addressed before merging.
PullRequestReviewEventDismiss PullRequestReviewEvent = "DISMISS" // Dismiss review so it now longer effects merging.
)
PullRequestReviewState represents the possible states of a pull request review.
type PullRequestReviewState string
The possible states of a pull request review.
const (
PullRequestReviewStatePending PullRequestReviewState = "PENDING" // A review that has not yet been submitted.
PullRequestReviewStateCommented PullRequestReviewState = "COMMENTED" // An informational review.
PullRequestReviewStateApproved PullRequestReviewState = "APPROVED" // A review allowing the pull request to merge.
PullRequestReviewStateChangesRequested PullRequestReviewState = "CHANGES_REQUESTED" // A review blocking the pull request from merging.
PullRequestReviewStateDismissed PullRequestReviewState = "DISMISSED" // A review that has been dismissed.
)
PullRequestReviewThreadSubjectType represents the possible subject types of a pull request review comment.
type PullRequestReviewThreadSubjectType string
The possible subject types of a pull request review comment.
const (
PullRequestReviewThreadSubjectTypeLine PullRequestReviewThreadSubjectType = "LINE" // A comment that has been made against the line of a pull request.
PullRequestReviewThreadSubjectTypeFile PullRequestReviewThreadSubjectType = "FILE" // A comment that has been made against the file of a pull request.
)
PullRequestState represents the possible states of a pull request.
type PullRequestState string
The possible states of a pull request.
const (
PullRequestStateOpen PullRequestState = "OPEN" // A pull request that is still open.
PullRequestStateClosed PullRequestState = "CLOSED" // A pull request that has been closed without being merged.
PullRequestStateMerged PullRequestState = "MERGED" // A pull request that has been closed by being merged.
)
PullRequestTimelineItemsItemType represents the possible item types found in a timeline.
type PullRequestTimelineItemsItemType string
The possible item types found in a timeline.
const (
PullRequestTimelineItemsItemTypePullRequestCommit PullRequestTimelineItemsItemType = "PULL_REQUEST_COMMIT" // Represents a Git commit part of a pull request.
PullRequestTimelineItemsItemTypePullRequestCommitCommentThread PullRequestTimelineItemsItemType = "PULL_REQUEST_COMMIT_COMMENT_THREAD" // Represents a commit comment thread part of a pull request.
PullRequestTimelineItemsItemTypePullRequestReview PullRequestTimelineItemsItemType = "PULL_REQUEST_REVIEW" // A review object for a given pull request.
PullRequestTimelineItemsItemTypePullRequestReviewThread PullRequestTimelineItemsItemType = "PULL_REQUEST_REVIEW_THREAD" // A threaded list of comments for a given pull request.
PullRequestTimelineItemsItemTypePullRequestRevisionMarker PullRequestTimelineItemsItemType = "PULL_REQUEST_REVISION_MARKER" // Represents the latest point in the pull request timeline for which the viewer has seen the pull request's commits.
PullRequestTimelineItemsItemTypeAutomaticBaseChangeFailedEvent PullRequestTimelineItemsItemType = "AUTOMATIC_BASE_CHANGE_FAILED_EVENT" // Represents a 'automatic_base_change_failed' event on a given pull request.
PullRequestTimelineItemsItemTypeAutomaticBaseChangeSucceededEvent PullRequestTimelineItemsItemType = "AUTOMATIC_BASE_CHANGE_SUCCEEDED_EVENT" // Represents a 'automatic_base_change_succeeded' event on a given pull request.
PullRequestTimelineItemsItemTypeAutoMergeDisabledEvent PullRequestTimelineItemsItemType = "AUTO_MERGE_DISABLED_EVENT" // Represents a 'auto_merge_disabled' event on a given pull request.
PullRequestTimelineItemsItemTypeAutoMergeEnabledEvent PullRequestTimelineItemsItemType = "AUTO_MERGE_ENABLED_EVENT" // Represents a 'auto_merge_enabled' event on a given pull request.
PullRequestTimelineItemsItemTypeAutoRebaseEnabledEvent PullRequestTimelineItemsItemType = "AUTO_REBASE_ENABLED_EVENT" // Represents a 'auto_rebase_enabled' event on a given pull request.
PullRequestTimelineItemsItemTypeAutoSquashEnabledEvent PullRequestTimelineItemsItemType = "AUTO_SQUASH_ENABLED_EVENT" // Represents a 'auto_squash_enabled' event on a given pull request.
PullRequestTimelineItemsItemTypeBaseRefChangedEvent PullRequestTimelineItemsItemType = "BASE_REF_CHANGED_EVENT" // Represents a 'base_ref_changed' event on a given issue or pull request.
PullRequestTimelineItemsItemTypeBaseRefForcePushedEvent PullRequestTimelineItemsItemType = "BASE_REF_FORCE_PUSHED_EVENT" // Represents a 'base_ref_force_pushed' event on a given pull request.
PullRequestTimelineItemsItemTypeBaseRefDeletedEvent PullRequestTimelineItemsItemType = "BASE_REF_DELETED_EVENT" // Represents a 'base_ref_deleted' event on a given pull request.
PullRequestTimelineItemsItemTypeDeployedEvent PullRequestTimelineItemsItemType = "DEPLOYED_EVENT" // Represents a 'deployed' event on a given pull request.
PullRequestTimelineItemsItemTypeDeploymentEnvironmentChangedEvent PullRequestTimelineItemsItemType = "DEPLOYMENT_ENVIRONMENT_CHANGED_EVENT" // Represents a 'deployment_environment_changed' event on a given pull request.
PullRequestTimelineItemsItemTypeHeadRefDeletedEvent PullRequestTimelineItemsItemType = "HEAD_REF_DELETED_EVENT" // Represents a 'head_ref_deleted' event on a given pull request.
PullRequestTimelineItemsItemTypeHeadRefForcePushedEvent PullRequestTimelineItemsItemType = "HEAD_REF_FORCE_PUSHED_EVENT" // Represents a 'head_ref_force_pushed' event on a given pull request.
PullRequestTimelineItemsItemTypeHeadRefRestoredEvent PullRequestTimelineItemsItemType = "HEAD_REF_RESTORED_EVENT" // Represents a 'head_ref_restored' event on a given pull request.
PullRequestTimelineItemsItemTypeMergedEvent PullRequestTimelineItemsItemType = "MERGED_EVENT" // Represents a 'merged' event on a given pull request.
PullRequestTimelineItemsItemTypeReviewDismissedEvent PullRequestTimelineItemsItemType = "REVIEW_DISMISSED_EVENT" // Represents a 'review_dismissed' event on a given issue or pull request.
PullRequestTimelineItemsItemTypeReviewRequestedEvent PullRequestTimelineItemsItemType = "REVIEW_REQUESTED_EVENT" // Represents an 'review_requested' event on a given pull request.
PullRequestTimelineItemsItemTypeReviewRequestRemovedEvent PullRequestTimelineItemsItemType = "REVIEW_REQUEST_REMOVED_EVENT" // Represents an 'review_request_removed' event on a given pull request.
PullRequestTimelineItemsItemTypeReadyForReviewEvent PullRequestTimelineItemsItemType = "READY_FOR_REVIEW_EVENT" // Represents a 'ready_for_review' event on a given pull request.
PullRequestTimelineItemsItemTypeConvertToDraftEvent PullRequestTimelineItemsItemType = "CONVERT_TO_DRAFT_EVENT" // Represents a 'convert_to_draft' event on a given pull request.
PullRequestTimelineItemsItemTypeAddedToMergeQueueEvent PullRequestTimelineItemsItemType = "ADDED_TO_MERGE_QUEUE_EVENT" // Represents an 'added_to_merge_queue' event on a given pull request.
PullRequestTimelineItemsItemTypeRemovedFromMergeQueueEvent PullRequestTimelineItemsItemType = "REMOVED_FROM_MERGE_QUEUE_EVENT" // Represents a 'removed_from_merge_queue' event on a given pull request.
PullRequestTimelineItemsItemTypeIssueComment PullRequestTimelineItemsItemType = "ISSUE_COMMENT" // Represents a comment on an Issue.
PullRequestTimelineItemsItemTypeCrossReferencedEvent PullRequestTimelineItemsItemType = "CROSS_REFERENCED_EVENT" // Represents a mention made by one issue or pull request to another.
PullRequestTimelineItemsItemTypeAddedToProjectEvent PullRequestTimelineItemsItemType = "ADDED_TO_PROJECT_EVENT" // Represents a 'added_to_project' event on a given issue or pull request.
PullRequestTimelineItemsItemTypeAssignedEvent PullRequestTimelineItemsItemType = "ASSIGNED_EVENT" // Represents an 'assigned' event on any assignable object.
PullRequestTimelineItemsItemTypeClosedEvent PullRequestTimelineItemsItemType = "CLOSED_EVENT" // Represents a 'closed' event on any `Closable`.
PullRequestTimelineItemsItemTypeCommentDeletedEvent PullRequestTimelineItemsItemType = "COMMENT_DELETED_EVENT" // Represents a 'comment_deleted' event on a given issue or pull request.
PullRequestTimelineItemsItemTypeConnectedEvent PullRequestTimelineItemsItemType = "CONNECTED_EVENT" // Represents a 'connected' event on a given issue or pull request.
PullRequestTimelineItemsItemTypeConvertedNoteToIssueEvent PullRequestTimelineItemsItemType = "CONVERTED_NOTE_TO_ISSUE_EVENT" // Represents a 'converted_note_to_issue' event on a given issue or pull request.
PullRequestTimelineItemsItemTypeConvertedToDiscussionEvent PullRequestTimelineItemsItemType = "CONVERTED_TO_DISCUSSION_EVENT" // Represents a 'converted_to_discussion' event on a given issue.
PullRequestTimelineItemsItemTypeDemilestonedEvent PullRequestTimelineItemsItemType = "DEMILESTONED_EVENT" // Represents a 'demilestoned' event on a given issue or pull request.
PullRequestTimelineItemsItemTypeDisconnectedEvent PullRequestTimelineItemsItemType = "DISCONNECTED_EVENT" // Represents a 'disconnected' event on a given issue or pull request.
PullRequestTimelineItemsItemTypeLabeledEvent PullRequestTimelineItemsItemType = "LABELED_EVENT" // Represents a 'labeled' event on a given issue or pull request.
PullRequestTimelineItemsItemTypeLockedEvent PullRequestTimelineItemsItemType = "LOCKED_EVENT" // Represents a 'locked' event on a given issue or pull request.
PullRequestTimelineItemsItemTypeMarkedAsDuplicateEvent PullRequestTimelineItemsItemType = "MARKED_AS_DUPLICATE_EVENT" // Represents a 'marked_as_duplicate' event on a given issue or pull request.
PullRequestTimelineItemsItemTypeMentionedEvent PullRequestTimelineItemsItemType = "MENTIONED_EVENT" // Represents a 'mentioned' event on a given issue or pull request.
PullRequestTimelineItemsItemTypeMilestonedEvent PullRequestTimelineItemsItemType = "MILESTONED_EVENT" // Represents a 'milestoned' event on a given issue or pull request.
PullRequestTimelineItemsItemTypeMovedColumnsInProjectEvent PullRequestTimelineItemsItemType = "MOVED_COLUMNS_IN_PROJECT_EVENT" // Represents a 'moved_columns_in_project' event on a given issue or pull request.
PullRequestTimelineItemsItemTypePinnedEvent PullRequestTimelineItemsItemType = "PINNED_EVENT" // Represents a 'pinned' event on a given issue or pull request.
PullRequestTimelineItemsItemTypeReferencedEvent PullRequestTimelineItemsItemType = "REFERENCED_EVENT" // Represents a 'referenced' event on a given `ReferencedSubject`.
PullRequestTimelineItemsItemTypeRemovedFromProjectEvent PullRequestTimelineItemsItemType = "REMOVED_FROM_PROJECT_EVENT" // Represents a 'removed_from_project' event on a given issue or pull request.
PullRequestTimelineItemsItemTypeRenamedTitleEvent PullRequestTimelineItemsItemType = "RENAMED_TITLE_EVENT" // Represents a 'renamed' event on a given issue or pull request.
PullRequestTimelineItemsItemTypeReopenedEvent PullRequestTimelineItemsItemType = "REOPENED_EVENT" // Represents a 'reopened' event on any `Closable`.
PullRequestTimelineItemsItemTypeSubscribedEvent PullRequestTimelineItemsItemType = "SUBSCRIBED_EVENT" // Represents a 'subscribed' event on a given `Subscribable`.
PullRequestTimelineItemsItemTypeTransferredEvent PullRequestTimelineItemsItemType = "TRANSFERRED_EVENT" // Represents a 'transferred' event on a given issue or pull request.
PullRequestTimelineItemsItemTypeUnassignedEvent PullRequestTimelineItemsItemType = "UNASSIGNED_EVENT" // Represents an 'unassigned' event on any assignable object.
PullRequestTimelineItemsItemTypeUnlabeledEvent PullRequestTimelineItemsItemType = "UNLABELED_EVENT" // Represents an 'unlabeled' event on a given issue or pull request.
PullRequestTimelineItemsItemTypeUnlockedEvent PullRequestTimelineItemsItemType = "UNLOCKED_EVENT" // Represents an 'unlocked' event on a given issue or pull request.
PullRequestTimelineItemsItemTypeUserBlockedEvent PullRequestTimelineItemsItemType = "USER_BLOCKED_EVENT" // Represents a 'user_blocked' event on a given user.
PullRequestTimelineItemsItemTypeUnmarkedAsDuplicateEvent PullRequestTimelineItemsItemType = "UNMARKED_AS_DUPLICATE_EVENT" // Represents an 'unmarked_as_duplicate' event on a given issue or pull request.
PullRequestTimelineItemsItemTypeUnpinnedEvent PullRequestTimelineItemsItemType = "UNPINNED_EVENT" // Represents an 'unpinned' event on a given issue or pull request.
PullRequestTimelineItemsItemTypeUnsubscribedEvent PullRequestTimelineItemsItemType = "UNSUBSCRIBED_EVENT" // Represents an 'unsubscribed' event on a given `Subscribable`.
)
PullRequestUpdateState represents the possible target states when updating a pull request.
type PullRequestUpdateState string
The possible target states when updating a pull request.
const (
PullRequestUpdateStateOpen PullRequestUpdateState = "OPEN" // A pull request that is still open.
PullRequestUpdateStateClosed PullRequestUpdateState = "CLOSED" // A pull request that has been closed without being merged.
)
ReactionContent represents emojis that can be attached to Issues, Pull Requests and Comments.
type ReactionContent string
Emojis that can be attached to Issues, Pull Requests and Comments.
const (
ReactionContentThumbsUp ReactionContent = "THUMBS_UP" // Represents the `:+1:` emoji.
ReactionContentThumbsDown ReactionContent = "THUMBS_DOWN" // Represents the `:-1:` emoji.
ReactionContentLaugh ReactionContent = "LAUGH" // Represents the `:laugh:` emoji.
ReactionContentHooray ReactionContent = "HOORAY" // Represents the `:hooray:` emoji.
ReactionContentConfused ReactionContent = "CONFUSED" // Represents the `:confused:` emoji.
ReactionContentHeart ReactionContent = "HEART" // Represents the `:heart:` emoji.
ReactionContentRocket ReactionContent = "ROCKET" // Represents the `:rocket:` emoji.
ReactionContentEyes ReactionContent = "EYES" // Represents the `:eyes:` emoji.
)
ReactionOrder represents ways in which lists of reactions can be ordered upon return.
type ReactionOrder struct {
// The field in which to order reactions by. (Required.)
Field ReactionOrderField `json:"field"`
// The direction in which to order reactions by the specified field. (Required.)
Direction OrderDirection `json:"direction"`
}
ReactionOrderField represents a list of fields that reactions can be ordered by.
type ReactionOrderField string
A list of fields that reactions can be ordered by.
const (
ReactionOrderFieldCreatedAt ReactionOrderField = "CREATED_AT" // Allows ordering a list of reactions by when they were created.
)
RefNameConditionTargetInput represents parameters to be used for the ref_name condition.
type RefNameConditionTargetInput struct {
// Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match. (Required.)
Exclude []String `json:"exclude"`
// Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches. (Required.)
Include []String `json:"include"`
}
RefOrder represents ways in which lists of git refs can be ordered upon return.
type RefOrder struct {
// The field in which to order refs by. (Required.)
Field RefOrderField `json:"field"`
// The direction in which to order refs by the specified field. (Required.)
Direction OrderDirection `json:"direction"`
}
RefOrderField represents properties by which ref connections can be ordered.
type RefOrderField string
Properties by which ref connections can be ordered.
const (
RefOrderFieldTagCommitDate RefOrderField = "TAG_COMMIT_DATE" // Order refs by underlying commit date if the ref prefix is refs/tags/.
RefOrderFieldAlphabetical RefOrderField = "ALPHABETICAL" // Order refs by their alphanumeric name.
)
RefUpdate represents a ref update.
type RefUpdate struct {
// The fully qualified name of the ref to be update. For example `refs/heads/branch-name`. (Required.)
Name GitRefname `json:"name"`
// The value this ref should be updated to. (Required.)
AfterOid GitObjectID `json:"afterOid"`
// The value this ref needs to point to before the update. (Optional.)
BeforeOid *GitObjectID `json:"beforeOid,omitempty"`
// Force a non fast-forward update. (Optional.)
Force *Boolean `json:"force,omitempty"`
}
RegenerateEnterpriseIdentityProviderRecoveryCodesInput is an autogenerated input type of RegenerateEnterpriseIdentityProviderRecoveryCodes.
type RegenerateEnterpriseIdentityProviderRecoveryCodesInput struct {
// The ID of the enterprise on which to set an identity provider. (Required.)
EnterpriseID ID `json:"enterpriseId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
RegenerateVerifiableDomainTokenInput is an autogenerated input type of RegenerateVerifiableDomainToken.
type RegenerateVerifiableDomainTokenInput struct {
// The ID of the verifiable domain to regenerate the verification token of. (Required.)
ID ID `json:"id"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
RejectDeploymentsInput is an autogenerated input type of RejectDeployments.
type RejectDeploymentsInput struct {
// The node ID of the workflow run containing the pending deployments. (Required.)
WorkflowRunID ID `json:"workflowRunId"`
// The ids of environments to reject deployments. (Required.)
EnvironmentIDs []ID `json:"environmentIds"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
// Optional comment for rejecting deployments. (Optional.)
Comment *String `json:"comment,omitempty"`
}
ReleaseOrder represents ways in which lists of releases can be ordered upon return.
type ReleaseOrder struct {
// The field in which to order releases by. (Required.)
Field ReleaseOrderField `json:"field"`
// The direction in which to order releases by the specified field. (Required.)
Direction OrderDirection `json:"direction"`
}
ReleaseOrderField represents properties by which release connections can be ordered.
type ReleaseOrderField string
Properties by which release connections can be ordered.
const (
ReleaseOrderFieldCreatedAt ReleaseOrderField = "CREATED_AT" // Order releases by creation time.
ReleaseOrderFieldName ReleaseOrderField = "NAME" // Order releases alphabetically by name.
)
RemoveAssigneesFromAssignableInput is an autogenerated input type of RemoveAssigneesFromAssignable.
type RemoveAssigneesFromAssignableInput struct {
// The id of the assignable object to remove assignees from. (Required.)
AssignableID ID `json:"assignableId"`
// The id of users to remove as assignees. (Required.)
AssigneeIDs []ID `json:"assigneeIds"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
RemoveEnterpriseAdminInput is an autogenerated input type of RemoveEnterpriseAdmin.
type RemoveEnterpriseAdminInput struct {
// The Enterprise ID from which to remove the administrator. (Required.)
EnterpriseID ID `json:"enterpriseId"`
// The login of the user to remove as an administrator. (Required.)
Login String `json:"login"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
RemoveEnterpriseIdentityProviderInput is an autogenerated input type of RemoveEnterpriseIdentityProvider.
type RemoveEnterpriseIdentityProviderInput struct {
// The ID of the enterprise from which to remove the identity provider. (Required.)
EnterpriseID ID `json:"enterpriseId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
RemoveEnterpriseMemberInput is an autogenerated input type of RemoveEnterpriseMember.
type RemoveEnterpriseMemberInput struct {
// The ID of the enterprise from which the user should be removed. (Required.)
EnterpriseID ID `json:"enterpriseId"`
// The ID of the user to remove from the enterprise. (Required.)
UserID ID `json:"userId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
RemoveEnterpriseOrganizationInput is an autogenerated input type of RemoveEnterpriseOrganization.
type RemoveEnterpriseOrganizationInput struct {
// The ID of the enterprise from which the organization should be removed. (Required.)
EnterpriseID ID `json:"enterpriseId"`
// The ID of the organization to remove from the enterprise. (Required.)
OrganizationID ID `json:"organizationId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
RemoveEnterpriseSupportEntitlementInput is an autogenerated input type of RemoveEnterpriseSupportEntitlement.
type RemoveEnterpriseSupportEntitlementInput struct {
// The ID of the Enterprise which the admin belongs to. (Required.)
EnterpriseID ID `json:"enterpriseId"`
// The login of a member who will lose the support entitlement. (Required.)
Login String `json:"login"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
RemoveLabelsFromLabelableInput is an autogenerated input type of RemoveLabelsFromLabelable.
type RemoveLabelsFromLabelableInput struct {
// The id of the Labelable to remove labels from. (Required.)
LabelableID ID `json:"labelableId"`
// The ids of labels to remove. (Required.)
LabelIDs []ID `json:"labelIds"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
RemoveOutsideCollaboratorInput is an autogenerated input type of RemoveOutsideCollaborator.
type RemoveOutsideCollaboratorInput struct {
// The ID of the outside collaborator to remove. (Required.)
UserID ID `json:"userId"`
// The ID of the organization to remove the outside collaborator from. (Required.)
OrganizationID ID `json:"organizationId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
RemoveReactionInput is an autogenerated input type of RemoveReaction.
type RemoveReactionInput struct {
// The Node ID of the subject to modify. (Required.)
SubjectID ID `json:"subjectId"`
// The name of the emoji reaction to remove. (Required.)
Content ReactionContent `json:"content"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
RemoveStarInput is an autogenerated input type of RemoveStar.
type RemoveStarInput struct {
// The Starrable ID to unstar. (Required.)
StarrableID ID `json:"starrableId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
RemoveUpvoteInput is an autogenerated input type of RemoveUpvote.
type RemoveUpvoteInput struct {
// The Node ID of the discussion or comment to remove upvote. (Required.)
SubjectID ID `json:"subjectId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
ReopenDiscussionInput is an autogenerated input type of ReopenDiscussion.
type ReopenDiscussionInput struct {
// ID of the discussion to be reopened. (Required.)
DiscussionID ID `json:"discussionId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
ReopenIssueInput is an autogenerated input type of ReopenIssue.
type ReopenIssueInput struct {
// ID of the issue to be opened. (Required.)
IssueID ID `json:"issueId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
ReopenPullRequestInput is an autogenerated input type of ReopenPullRequest.
type ReopenPullRequestInput struct {
// ID of the pull request to be reopened. (Required.)
PullRequestID ID `json:"pullRequestId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
ReorderEnvironmentInput is an autogenerated input type of ReorderEnvironment.
type ReorderEnvironmentInput struct {
// The ID of the environment to modify. (Required.)
EnvironmentID ID `json:"environmentId"`
// The desired position of the environment. (Required.)
Position Int `json:"position"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
RepoAccessAuditEntryVisibility represents the privacy of a repository.
type RepoAccessAuditEntryVisibility string
The privacy of a repository.
const (
RepoAccessAuditEntryVisibilityInternal RepoAccessAuditEntryVisibility = "INTERNAL" // The repository is visible only to users in the same business.
RepoAccessAuditEntryVisibilityPrivate RepoAccessAuditEntryVisibility = "PRIVATE" // The repository is visible only to those with explicit access.
RepoAccessAuditEntryVisibilityPublic RepoAccessAuditEntryVisibility = "PUBLIC" // The repository is visible to everyone.
)
RepoAddMemberAuditEntryVisibility represents the privacy of a repository.
type RepoAddMemberAuditEntryVisibility string
The privacy of a repository.
const (
RepoAddMemberAuditEntryVisibilityInternal RepoAddMemberAuditEntryVisibility = "INTERNAL" // The repository is visible only to users in the same business.
RepoAddMemberAuditEntryVisibilityPrivate RepoAddMemberAuditEntryVisibility = "PRIVATE" // The repository is visible only to those with explicit access.
RepoAddMemberAuditEntryVisibilityPublic RepoAddMemberAuditEntryVisibility = "PUBLIC" // The repository is visible to everyone.
)
RepoArchivedAuditEntryVisibility represents the privacy of a repository.
type RepoArchivedAuditEntryVisibility string
The privacy of a repository.
const (
RepoArchivedAuditEntryVisibilityInternal RepoArchivedAuditEntryVisibility = "INTERNAL" // The repository is visible only to users in the same business.
RepoArchivedAuditEntryVisibilityPrivate RepoArchivedAuditEntryVisibility = "PRIVATE" // The repository is visible only to those with explicit access.
RepoArchivedAuditEntryVisibilityPublic RepoArchivedAuditEntryVisibility = "PUBLIC" // The repository is visible to everyone.
)
RepoChangeMergeSettingAuditEntryMergeType represents the merge options available for pull requests to this repository.
type RepoChangeMergeSettingAuditEntryMergeType string
The merge options available for pull requests to this repository.
const (
RepoChangeMergeSettingAuditEntryMergeTypeMerge RepoChangeMergeSettingAuditEntryMergeType = "MERGE" // The pull request is added to the base branch in a merge commit.
RepoChangeMergeSettingAuditEntryMergeTypeRebase RepoChangeMergeSettingAuditEntryMergeType = "REBASE" // Commits from the pull request are added onto the base branch individually without a merge commit.
RepoChangeMergeSettingAuditEntryMergeTypeSquash RepoChangeMergeSettingAuditEntryMergeType = "SQUASH" // The pull request's commits are squashed into a single commit before they are merged to the base branch.
)
RepoCreateAuditEntryVisibility represents the privacy of a repository.
type RepoCreateAuditEntryVisibility string
The privacy of a repository.
const (
RepoCreateAuditEntryVisibilityInternal RepoCreateAuditEntryVisibility = "INTERNAL" // The repository is visible only to users in the same business.
RepoCreateAuditEntryVisibilityPrivate RepoCreateAuditEntryVisibility = "PRIVATE" // The repository is visible only to those with explicit access.
RepoCreateAuditEntryVisibilityPublic RepoCreateAuditEntryVisibility = "PUBLIC" // The repository is visible to everyone.
)
RepoDestroyAuditEntryVisibility represents the privacy of a repository.
type RepoDestroyAuditEntryVisibility string
The privacy of a repository.
const (
RepoDestroyAuditEntryVisibilityInternal RepoDestroyAuditEntryVisibility = "INTERNAL" // The repository is visible only to users in the same business.
RepoDestroyAuditEntryVisibilityPrivate RepoDestroyAuditEntryVisibility = "PRIVATE" // The repository is visible only to those with explicit access.
RepoDestroyAuditEntryVisibilityPublic RepoDestroyAuditEntryVisibility = "PUBLIC" // The repository is visible to everyone.
)
RepoRemoveMemberAuditEntryVisibility represents the privacy of a repository.
type RepoRemoveMemberAuditEntryVisibility string
The privacy of a repository.
const (
RepoRemoveMemberAuditEntryVisibilityInternal RepoRemoveMemberAuditEntryVisibility = "INTERNAL" // The repository is visible only to users in the same business.
RepoRemoveMemberAuditEntryVisibilityPrivate RepoRemoveMemberAuditEntryVisibility = "PRIVATE" // The repository is visible only to those with explicit access.
RepoRemoveMemberAuditEntryVisibilityPublic RepoRemoveMemberAuditEntryVisibility = "PUBLIC" // The repository is visible to everyone.
)
ReportedContentClassifiers represents the reasons a piece of content can be reported or minimized.
type ReportedContentClassifiers string
The reasons a piece of content can be reported or minimized.
const (
ReportedContentClassifiersSpam ReportedContentClassifiers = "SPAM" // A spammy piece of content.
ReportedContentClassifiersAbuse ReportedContentClassifiers = "ABUSE" // An abusive or harassing piece of content.
ReportedContentClassifiersOffTopic ReportedContentClassifiers = "OFF_TOPIC" // An irrelevant piece of content.
ReportedContentClassifiersOutdated ReportedContentClassifiers = "OUTDATED" // An outdated piece of content.
ReportedContentClassifiersDuplicate ReportedContentClassifiers = "DUPLICATE" // A duplicated piece of content.
ReportedContentClassifiersResolved ReportedContentClassifiers = "RESOLVED" // The content has been resolved.
)
RepositoryAffiliation represents the affiliation of a user to a repository.
type RepositoryAffiliation string
The affiliation of a user to a repository.
const (
RepositoryAffiliationOwner RepositoryAffiliation = "OWNER" // Repositories that are owned by the authenticated user.
RepositoryAffiliationCollaborator RepositoryAffiliation = "COLLABORATOR" // Repositories that the user has been added to as a collaborator.
RepositoryAffiliationOrganizationMember RepositoryAffiliation = "ORGANIZATION_MEMBER" // Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on.
)
RepositoryContributionType represents the reason a repository is listed as 'contributed'.
type RepositoryContributionType string
The reason a repository is listed as 'contributed'.
const (
RepositoryContributionTypeCommit RepositoryContributionType = "COMMIT" // Created a commit.
RepositoryContributionTypeIssue RepositoryContributionType = "ISSUE" // Created an issue.
RepositoryContributionTypePullRequest RepositoryContributionType = "PULL_REQUEST" // Created a pull request.
RepositoryContributionTypeRepository RepositoryContributionType = "REPOSITORY" // Created the repository.
RepositoryContributionTypePullRequestReview RepositoryContributionType = "PULL_REQUEST_REVIEW" // Reviewed a pull request.
)
RepositoryIdConditionTargetInput represents parameters to be used for the repository_id condition.
type RepositoryIdConditionTargetInput struct {
// One of these repo IDs must match the repo. (Required.)
RepositoryIDs []ID `json:"repositoryIds"`
}
RepositoryInteractionLimit represents a repository interaction limit.
type RepositoryInteractionLimit string
A repository interaction limit.
const (
RepositoryInteractionLimitExistingUsers RepositoryInteractionLimit = "EXISTING_USERS" // Users that have recently created their account will be unable to interact with the repository.
RepositoryInteractionLimitContributorsOnly RepositoryInteractionLimit = "CONTRIBUTORS_ONLY" // Users that have not previously committed to a repository’s default branch will be unable to interact with the repository.
RepositoryInteractionLimitCollaboratorsOnly RepositoryInteractionLimit = "COLLABORATORS_ONLY" // Users that are not collaborators will not be able to interact with the repository.
RepositoryInteractionLimitNoLimit RepositoryInteractionLimit = "NO_LIMIT" // No interaction limits are enabled.
)
RepositoryInteractionLimitExpiry represents the length for a repository interaction limit to be enabled for.
type RepositoryInteractionLimitExpiry string
The length for a repository interaction limit to be enabled for.
const (
RepositoryInteractionLimitExpiryOneDay RepositoryInteractionLimitExpiry = "ONE_DAY" // The interaction limit will expire after 1 day.
RepositoryInteractionLimitExpiryThreeDays RepositoryInteractionLimitExpiry = "THREE_DAYS" // The interaction limit will expire after 3 days.
RepositoryInteractionLimitExpiryOneWeek RepositoryInteractionLimitExpiry = "ONE_WEEK" // The interaction limit will expire after 1 week.
RepositoryInteractionLimitExpiryOneMonth RepositoryInteractionLimitExpiry = "ONE_MONTH" // The interaction limit will expire after 1 month.
RepositoryInteractionLimitExpirySixMonths RepositoryInteractionLimitExpiry = "SIX_MONTHS" // The interaction limit will expire after 6 months.
)
RepositoryInteractionLimitOrigin represents indicates where an interaction limit is configured.
type RepositoryInteractionLimitOrigin string
Indicates where an interaction limit is configured.
const (
RepositoryInteractionLimitOriginRepository RepositoryInteractionLimitOrigin = "REPOSITORY" // A limit that is configured at the repository level.
RepositoryInteractionLimitOriginOrganization RepositoryInteractionLimitOrigin = "ORGANIZATION" // A limit that is configured at the organization level.
RepositoryInteractionLimitOriginUser RepositoryInteractionLimitOrigin = "USER" // A limit that is configured at the user-wide level.
)
RepositoryInvitationOrder represents ordering options for repository invitation connections.
type RepositoryInvitationOrder struct {
// The field to order repository invitations by. (Required.)
Field RepositoryInvitationOrderField `json:"field"`
// The ordering direction. (Required.)
Direction OrderDirection `json:"direction"`
}
RepositoryInvitationOrderField represents properties by which repository invitation connections can be ordered.
type RepositoryInvitationOrderField string
Properties by which repository invitation connections can be ordered.
const (
RepositoryInvitationOrderFieldCreatedAt RepositoryInvitationOrderField = "CREATED_AT" // Order repository invitations by creation time.
)
RepositoryLockReason represents the possible reasons a given repository could be in a locked state.
type RepositoryLockReason string
The possible reasons a given repository could be in a locked state.
const (
RepositoryLockReasonMoving RepositoryLockReason = "MOVING" // The repository is locked due to a move.
RepositoryLockReasonBilling RepositoryLockReason = "BILLING" // The repository is locked due to a billing related reason.
RepositoryLockReasonRename RepositoryLockReason = "RENAME" // The repository is locked due to a rename.
RepositoryLockReasonMigrating RepositoryLockReason = "MIGRATING" // The repository is locked due to a migration.
RepositoryLockReasonTradeRestriction RepositoryLockReason = "TRADE_RESTRICTION" // The repository is locked due to a trade controls related reason.
RepositoryLockReasonTransferringOwnership RepositoryLockReason = "TRANSFERRING_OWNERSHIP" // The repository is locked due to an ownership transfer.
)
RepositoryMigrationOrder represents ordering options for repository migrations.
type RepositoryMigrationOrder struct {
// The field to order repository migrations by. (Required.)
Field RepositoryMigrationOrderField `json:"field"`
// The ordering direction. (Required.)
Direction RepositoryMigrationOrderDirection `json:"direction"`
}
RepositoryMigrationOrderDirection represents possible directions in which to order a list of repository migrations when provided an `orderBy` argument.
type RepositoryMigrationOrderDirection string
Possible directions in which to order a list of repository migrations when provided an `orderBy` argument.
const (
RepositoryMigrationOrderDirectionAsc RepositoryMigrationOrderDirection = "ASC" // Specifies an ascending order for a given `orderBy` argument.
RepositoryMigrationOrderDirectionDesc RepositoryMigrationOrderDirection = "DESC" // Specifies a descending order for a given `orderBy` argument.
)
RepositoryMigrationOrderField represents properties by which repository migrations can be ordered.
type RepositoryMigrationOrderField string
Properties by which repository migrations can be ordered.
const (
RepositoryMigrationOrderFieldCreatedAt RepositoryMigrationOrderField = "CREATED_AT" // Order mannequins why when they were created.
)
RepositoryNameConditionTargetInput represents parameters to be used for the repository_name condition.
type RepositoryNameConditionTargetInput struct {
// Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match. (Required.)
Exclude []String `json:"exclude"`
// Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories. (Required.)
Include []String `json:"include"`
// Target changes that match these patterns will be prevented except by those with bypass permissions. (Optional.)
Protected *Boolean `json:"protected,omitempty"`
}
RepositoryOrder represents ordering options for repository connections.
type RepositoryOrder struct {
// The field to order repositories by. (Required.)
Field RepositoryOrderField `json:"field"`
// The ordering direction. (Required.)
Direction OrderDirection `json:"direction"`
}
RepositoryOrderField represents properties by which repository connections can be ordered.
type RepositoryOrderField string
Properties by which repository connections can be ordered.
const (
RepositoryOrderFieldCreatedAt RepositoryOrderField = "CREATED_AT" // Order repositories by creation time.
RepositoryOrderFieldUpdatedAt RepositoryOrderField = "UPDATED_AT" // Order repositories by update time.
RepositoryOrderFieldPushedAt RepositoryOrderField = "PUSHED_AT" // Order repositories by push time.
RepositoryOrderFieldName RepositoryOrderField = "NAME" // Order repositories by name.
RepositoryOrderFieldStargazers RepositoryOrderField = "STARGAZERS" // Order repositories by number of stargazers.
)
RepositoryPermission represents the access level to a repository.
type RepositoryPermission string
The access level to a repository.
const (
RepositoryPermissionAdmin RepositoryPermission = "ADMIN" // Can read, clone, and push to this repository. Can also manage issues, pull requests, and repository settings, including adding collaborators.
RepositoryPermissionMaintain RepositoryPermission = "MAINTAIN" // Can read, clone, and push to this repository. They can also manage issues, pull requests, and some repository settings.
RepositoryPermissionWrite RepositoryPermission = "WRITE" // Can read, clone, and push to this repository. Can also manage issues and pull requests.
RepositoryPermissionTriage RepositoryPermission = "TRIAGE" // Can read and clone this repository. Can also manage issues and pull requests.
RepositoryPermissionRead RepositoryPermission = "READ" // Can read and clone this repository. Can also open and comment on issues and pull requests.
)
RepositoryPrivacy represents the privacy of a repository.
type RepositoryPrivacy string
The privacy of a repository.
const (
RepositoryPrivacyPublic RepositoryPrivacy = "PUBLIC" // Public.
RepositoryPrivacyPrivate RepositoryPrivacy = "PRIVATE" // Private.
)
RepositoryPropertyConditionTargetInput represents parameters to be used for the repository_property condition.
type RepositoryPropertyConditionTargetInput struct {
// Array of repository properties that must not match. (Required.)
Exclude []PropertyTargetDefinitionInput `json:"exclude"`
// Array of repository properties that must match. (Required.)
Include []PropertyTargetDefinitionInput `json:"include"`
}
RepositoryRuleConditionsInput specifies the conditions required for a ruleset to evaluate.
type RepositoryRuleConditionsInput struct {
// Configuration for the ref_name condition. (Optional.)
RefName *RefNameConditionTargetInput `json:"refName,omitempty"`
// Configuration for the repository_name condition. (Optional.)
RepositoryName *RepositoryNameConditionTargetInput `json:"repositoryName,omitempty"`
// Configuration for the repository_id condition. (Optional.)
RepositoryID *RepositoryIdConditionTargetInput `json:"repositoryId,omitempty"`
// Configuration for the repository_property condition. (Optional.)
RepositoryProperty *RepositoryPropertyConditionTargetInput `json:"repositoryProperty,omitempty"`
}
RepositoryRuleInput specifies the attributes for a new or updated rule.
type RepositoryRuleInput struct {
// The type of rule to create. (Required.)
Type RepositoryRuleType `json:"type"`
// Optional ID of this rule when updating. (Optional.)
ID *ID `json:"id,omitempty"`
// The parameters for the rule. (Optional.)
Parameters *RuleParametersInput `json:"parameters,omitempty"`
}
RepositoryRuleOrder represents ordering options for repository rules.
type RepositoryRuleOrder struct {
// The field to order repository rules by. (Required.)
Field RepositoryRuleOrderField `json:"field"`
// The ordering direction. (Required.)
Direction OrderDirection `json:"direction"`
}
RepositoryRuleOrderField represents properties by which repository rule connections can be ordered.
type RepositoryRuleOrderField string
Properties by which repository rule connections can be ordered.
const (
RepositoryRuleOrderFieldUpdatedAt RepositoryRuleOrderField = "UPDATED_AT" // Order repository rules by updated time.
RepositoryRuleOrderFieldCreatedAt RepositoryRuleOrderField = "CREATED_AT" // Order repository rules by created time.
RepositoryRuleOrderFieldType RepositoryRuleOrderField = "TYPE" // Order repository rules by type.
)
RepositoryRuleType represents the rule types supported in rulesets.
type RepositoryRuleType string
The rule types supported in rulesets.
const (
RepositoryRuleTypeCreation RepositoryRuleType = "CREATION" // Only allow users with bypass permission to create matching refs.
RepositoryRuleTypeUpdate RepositoryRuleType = "UPDATE" // Only allow users with bypass permission to update matching refs.
RepositoryRuleTypeDeletion RepositoryRuleType = "DELETION" // Only allow users with bypass permissions to delete matching refs.
RepositoryRuleTypeRequiredLinearHistory RepositoryRuleType = "REQUIRED_LINEAR_HISTORY" // Prevent merge commits from being pushed to matching refs.
RepositoryRuleTypeMergeQueue RepositoryRuleType = "MERGE_QUEUE" // Merges must be performed via a merge queue.
RepositoryRuleTypeRequiredReviewThreadResolution RepositoryRuleType = "REQUIRED_REVIEW_THREAD_RESOLUTION" // When enabled, all conversations on code must be resolved before a pull request can be merged into a branch that matches this rule.
RepositoryRuleTypeRequiredDeployments RepositoryRuleType = "REQUIRED_DEPLOYMENTS" // Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.
RepositoryRuleTypeRequiredSignatures RepositoryRuleType = "REQUIRED_SIGNATURES" // Commits pushed to matching refs must have verified signatures.
RepositoryRuleTypePullRequest RepositoryRuleType = "PULL_REQUEST" // Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.
RepositoryRuleTypeRequiredStatusChecks RepositoryRuleType = "REQUIRED_STATUS_CHECKS" // Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.
RepositoryRuleTypeRequiredWorkflowStatusChecks RepositoryRuleType = "REQUIRED_WORKFLOW_STATUS_CHECKS" // Require all commits be made to a non-target branch and submitted via a pull request and required workflow checks to pass before they can be merged.
RepositoryRuleTypeNonFastForward RepositoryRuleType = "NON_FAST_FORWARD" // Prevent users with push access from force pushing to refs.
RepositoryRuleTypeAuthorization RepositoryRuleType = "AUTHORIZATION" // Authorization.
RepositoryRuleTypeTag RepositoryRuleType = "TAG" // Tag.
RepositoryRuleTypeMergeQueueLockedRef RepositoryRuleType = "MERGE_QUEUE_LOCKED_REF" // Merge queue locked ref.
RepositoryRuleTypeLockBranch RepositoryRuleType = "LOCK_BRANCH" // Branch is read-only. Users cannot push to the branch.
RepositoryRuleTypeMaxRefUpdates RepositoryRuleType = "MAX_REF_UPDATES" // Max ref updates.
RepositoryRuleTypeCommitMessagePattern RepositoryRuleType = "COMMIT_MESSAGE_PATTERN" // Commit message pattern.
RepositoryRuleTypeCommitAuthorEmailPattern RepositoryRuleType = "COMMIT_AUTHOR_EMAIL_PATTERN" // Commit author email pattern.
RepositoryRuleTypeCommitterEmailPattern RepositoryRuleType = "COMMITTER_EMAIL_PATTERN" // Committer email pattern.
RepositoryRuleTypeBranchNamePattern RepositoryRuleType = "BRANCH_NAME_PATTERN" // Branch name pattern.
RepositoryRuleTypeTagNamePattern RepositoryRuleType = "TAG_NAME_PATTERN" // Tag name pattern.
RepositoryRuleTypeFilePathRestriction RepositoryRuleType = "FILE_PATH_RESTRICTION" // Prevent commits that include changes in specified file paths from being pushed to the commit graph. NOTE: This rule is in beta and subject to change.
RepositoryRuleTypeMaxFilePathLength RepositoryRuleType = "MAX_FILE_PATH_LENGTH" // Prevent commits that include file paths that exceed a specified character limit from being pushed to the commit graph. NOTE: This rule is in beta and subject to change.
RepositoryRuleTypeFileExtensionRestriction RepositoryRuleType = "FILE_EXTENSION_RESTRICTION" // Prevent commits that include files with specified file extensions from being pushed to the commit graph. NOTE: This rule is in beta and subject to change.
RepositoryRuleTypeMaxFileSize RepositoryRuleType = "MAX_FILE_SIZE" // Prevent commits that exceed a specified file size limit from being pushed to the commit. NOTE: This rule is in beta and subject to change.
RepositoryRuleTypeWorkflows RepositoryRuleType = "WORKFLOWS" // Require all changes made to a targeted branch to pass the specified workflows before they can be merged.
RepositoryRuleTypeSecretScanning RepositoryRuleType = "SECRET_SCANNING" // Secret scanning.
RepositoryRuleTypeWorkflowUpdates RepositoryRuleType = "WORKFLOW_UPDATES" // Workflow files cannot be modified.
RepositoryRuleTypeCodeScanning RepositoryRuleType = "CODE_SCANNING" // Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.
)
RepositoryRulesetBypassActorBypassMode represents the bypass mode for a specific actor on a ruleset.
type RepositoryRulesetBypassActorBypassMode string
The bypass mode for a specific actor on a ruleset.
const (
RepositoryRulesetBypassActorBypassModeAlways RepositoryRulesetBypassActorBypassMode = "ALWAYS" // The actor can always bypass rules.
RepositoryRulesetBypassActorBypassModePullRequest RepositoryRulesetBypassActorBypassMode = "PULL_REQUEST" // The actor can only bypass rules via a pull request.
)
RepositoryRulesetBypassActorInput specifies the attributes for a new or updated ruleset bypass actor. Only one of `actor_id`, `repository_role_database_id`, `organization_admin`, or `deploy_key` should be specified.
type RepositoryRulesetBypassActorInput struct {
// The bypass mode for this actor. (Required.)
BypassMode RepositoryRulesetBypassActorBypassMode `json:"bypassMode"`
// For Team and Integration bypasses, the Team or Integration ID. (Optional.)
ActorID *ID `json:"actorId,omitempty"`
// For role bypasses, the role database ID. (Optional.)
RepositoryRoleDatabaseID *Int `json:"repositoryRoleDatabaseId,omitempty"`
// For organization owner bypasses, true. (Optional.)
OrganizationAdmin *Boolean `json:"organizationAdmin,omitempty"`
// For deploy key bypasses, true. Can only use ALWAYS as the bypass mode. (Optional.)
DeployKey *Boolean `json:"deployKey,omitempty"`
}
RepositoryRulesetTarget represents the targets supported for rulesets. NOTE: The push target is in beta and subject to change.
type RepositoryRulesetTarget string
The targets supported for rulesets. NOTE: The push target is in beta and subject to change.
const (
RepositoryRulesetTargetBranch RepositoryRulesetTarget = "BRANCH" // Branch.
RepositoryRulesetTargetTag RepositoryRulesetTarget = "TAG" // Tag.
RepositoryRulesetTargetPush RepositoryRulesetTarget = "PUSH" // Push.
)
RepositoryVisibility represents the repository's visibility level.
type RepositoryVisibility string
The repository's visibility level.
const (
RepositoryVisibilityPrivate RepositoryVisibility = "PRIVATE" // The repository is visible only to those with explicit access.
RepositoryVisibilityPublic RepositoryVisibility = "PUBLIC" // The repository is visible to everyone.
RepositoryVisibilityInternal RepositoryVisibility = "INTERNAL" // The repository is visible only to users in the same business.
)
RepositoryVulnerabilityAlertDependencyScope represents the possible scopes of an alert's dependency.
type RepositoryVulnerabilityAlertDependencyScope string
The possible scopes of an alert's dependency.
const (
RepositoryVulnerabilityAlertDependencyScopeRuntime RepositoryVulnerabilityAlertDependencyScope = "RUNTIME" // A dependency that is leveraged during application runtime.
RepositoryVulnerabilityAlertDependencyScopeDevelopment RepositoryVulnerabilityAlertDependencyScope = "DEVELOPMENT" // A dependency that is only used in development.
)
RepositoryVulnerabilityAlertState represents the possible states of an alert.
type RepositoryVulnerabilityAlertState string
The possible states of an alert.
const (
RepositoryVulnerabilityAlertStateOpen RepositoryVulnerabilityAlertState = "OPEN" // An alert that is still open.
RepositoryVulnerabilityAlertStateFixed RepositoryVulnerabilityAlertState = "FIXED" // An alert that has been resolved by a code change.
RepositoryVulnerabilityAlertStateDismissed RepositoryVulnerabilityAlertState = "DISMISSED" // An alert that has been manually closed by a user.
RepositoryVulnerabilityAlertStateAutoDismissed RepositoryVulnerabilityAlertState = "AUTO_DISMISSED" // An alert that has been automatically closed by Dependabot.
)
RequestReviewsInput is an autogenerated input type of RequestReviews.
type RequestReviewsInput struct {
// The Node ID of the pull request to modify. (Required.)
PullRequestID ID `json:"pullRequestId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
// The Node IDs of the user to request. (Optional.)
UserIDs *[]ID `json:"userIds,omitempty"`
// The Node IDs of the team to request. (Optional.)
TeamIDs *[]ID `json:"teamIds,omitempty"`
// Add users to the set rather than replace. (Optional.)
Union *Boolean `json:"union,omitempty"`
}
RequestableCheckStatusState represents the possible states that can be requested when creating a check run.
type RequestableCheckStatusState string
The possible states that can be requested when creating a check run.
const (
RequestableCheckStatusStateQueued RequestableCheckStatusState = "QUEUED" // The check suite or run has been queued.
RequestableCheckStatusStateInProgress RequestableCheckStatusState = "IN_PROGRESS" // The check suite or run is in progress.
RequestableCheckStatusStateCompleted RequestableCheckStatusState = "COMPLETED" // The check suite or run has been completed.
RequestableCheckStatusStateWaiting RequestableCheckStatusState = "WAITING" // The check suite or run is in waiting state.
RequestableCheckStatusStatePending RequestableCheckStatusState = "PENDING" // The check suite or run is in pending state.
)
RequiredDeploymentsParametersInput represents choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.
type RequiredDeploymentsParametersInput struct {
// The environments that must be successfully deployed to before branches can be merged. (Required.)
RequiredDeploymentEnvironments []String `json:"requiredDeploymentEnvironments"`
}
RequiredStatusCheckInput specifies the attributes for a new or updated required status check.
type RequiredStatusCheckInput struct {
// Status check context that must pass for commits to be accepted to the matching branch. (Required.)
Context String `json:"context"`
// The ID of the App that must set the status in order for it to be accepted. Omit this value to use whichever app has recently been setting this status, or use "any" to allow any app to set the status. (Optional.)
AppID *ID `json:"appId,omitempty"`
}
RequiredStatusChecksParametersInput represents choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.
type RequiredStatusChecksParametersInput struct {
// Status checks that are required. (Required.)
RequiredStatusChecks []StatusCheckConfigurationInput `json:"requiredStatusChecks"`
// Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled. (Required.)
StrictRequiredStatusChecksPolicy Boolean `json:"strictRequiredStatusChecksPolicy"`
// Allow repositories and branches to be created if a check would otherwise prohibit it. (Optional.)
DoNotEnforceOnCreate *Boolean `json:"doNotEnforceOnCreate,omitempty"`
}
RerequestCheckSuiteInput is an autogenerated input type of RerequestCheckSuite.
type RerequestCheckSuiteInput struct {
// The Node ID of the repository. (Required.)
RepositoryID ID `json:"repositoryId"`
// The Node ID of the check suite. (Required.)
CheckSuiteID ID `json:"checkSuiteId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
ResolveReviewThreadInput is an autogenerated input type of ResolveReviewThread.
type ResolveReviewThreadInput struct {
// The ID of the thread to resolve. (Required.)
ThreadID ID `json:"threadId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
RetireSponsorsTierInput is an autogenerated input type of RetireSponsorsTier.
type RetireSponsorsTierInput struct {
// The ID of the published tier to retire. (Required.)
TierID ID `json:"tierId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
RevertPullRequestInput is an autogenerated input type of RevertPullRequest.
type RevertPullRequestInput struct {
// The ID of the pull request to revert. (Required.)
PullRequestID ID `json:"pullRequestId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
// The title of the revert pull request. (Optional.)
Title *String `json:"title,omitempty"`
// The description of the revert pull request. (Optional.)
Body *String `json:"body,omitempty"`
// Indicates whether the revert pull request should be a draft. (Optional.)
Draft *Boolean `json:"draft,omitempty"`
}
RevokeEnterpriseOrganizationsMigratorRoleInput is an autogenerated input type of RevokeEnterpriseOrganizationsMigratorRole.
type RevokeEnterpriseOrganizationsMigratorRoleInput struct {
// The ID of the enterprise to which all organizations managed by it will be granted the migrator role. (Required.)
EnterpriseID ID `json:"enterpriseId"`
// The login of the user to revoke the migrator role. (Required.)
Login String `json:"login"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
RevokeMigratorRoleInput is an autogenerated input type of RevokeMigratorRole.
type RevokeMigratorRoleInput struct {
// The ID of the organization that the user/team belongs to. (Required.)
OrganizationID ID `json:"organizationId"`
// The user login or Team slug to revoke the migrator role from. (Required.)
Actor String `json:"actor"`
// Specifies the type of the actor, can be either USER or TEAM. (Required.)
ActorType ActorType `json:"actorType"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
RoleInOrganization represents possible roles a user may have in relation to an organization.
type RoleInOrganization string
Possible roles a user may have in relation to an organization.
const (
RoleInOrganizationOwner RoleInOrganization = "OWNER" // A user with full administrative access to the organization.
RoleInOrganizationDirectMember RoleInOrganization = "DIRECT_MEMBER" // A user who is a direct member of the organization.
RoleInOrganizationUnaffiliated RoleInOrganization = "UNAFFILIATED" // A user who is unaffiliated with the organization.
)
RuleEnforcement represents the level of enforcement for a rule or ruleset.
type RuleEnforcement string
The level of enforcement for a rule or ruleset.
const (
RuleEnforcementDisabled RuleEnforcement = "DISABLED" // Do not evaluate or enforce rules.
RuleEnforcementActive RuleEnforcement = "ACTIVE" // Rules will be enforced.
RuleEnforcementEvaluate RuleEnforcement = "EVALUATE" // Allow admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (`evaluate` is only available with GitHub Enterprise).
)
RuleParametersInput specifies the parameters for a `RepositoryRule` object. Only one of the fields should be specified.
type RuleParametersInput struct {
// Parameters used for the `update` rule type. (Optional.)
Update *UpdateParametersInput `json:"update,omitempty"`
// Parameters used for the `merge_queue` rule type. (Optional.)
MergeQueue *MergeQueueParametersInput `json:"mergeQueue,omitempty"`
// Parameters used for the `required_deployments` rule type. (Optional.)
RequiredDeployments *RequiredDeploymentsParametersInput `json:"requiredDeployments,omitempty"`
// Parameters used for the `pull_request` rule type. (Optional.)
PullRequest *PullRequestParametersInput `json:"pullRequest,omitempty"`
// Parameters used for the `required_status_checks` rule type. (Optional.)
RequiredStatusChecks *RequiredStatusChecksParametersInput `json:"requiredStatusChecks,omitempty"`
// Parameters used for the `commit_message_pattern` rule type. (Optional.)
CommitMessagePattern *CommitMessagePatternParametersInput `json:"commitMessagePattern,omitempty"`
// Parameters used for the `commit_author_email_pattern` rule type. (Optional.)
CommitAuthorEmailPattern *CommitAuthorEmailPatternParametersInput `json:"commitAuthorEmailPattern,omitempty"`
// Parameters used for the `committer_email_pattern` rule type. (Optional.)
CommitterEmailPattern *CommitterEmailPatternParametersInput `json:"committerEmailPattern,omitempty"`
// Parameters used for the `branch_name_pattern` rule type. (Optional.)
BranchNamePattern *BranchNamePatternParametersInput `json:"branchNamePattern,omitempty"`
// Parameters used for the `tag_name_pattern` rule type. (Optional.)
TagNamePattern *TagNamePatternParametersInput `json:"tagNamePattern,omitempty"`
// Parameters used for the `file_path_restriction` rule type. (Optional.)
FilePathRestriction *FilePathRestrictionParametersInput `json:"filePathRestriction,omitempty"`
// Parameters used for the `max_file_path_length` rule type. (Optional.)
MaxFilePathLength *MaxFilePathLengthParametersInput `json:"maxFilePathLength,omitempty"`
// Parameters used for the `file_extension_restriction` rule type. (Optional.)
FileExtensionRestriction *FileExtensionRestrictionParametersInput `json:"fileExtensionRestriction,omitempty"`
// Parameters used for the `max_file_size` rule type. (Optional.)
MaxFileSize *MaxFileSizeParametersInput `json:"maxFileSize,omitempty"`
// Parameters used for the `workflows` rule type. (Optional.)
Workflows *WorkflowsParametersInput `json:"workflows,omitempty"`
// Parameters used for the `code_scanning` rule type. (Optional.)
CodeScanning *CodeScanningParametersInput `json:"codeScanning,omitempty"`
}
SamlDigestAlgorithm represents the possible digest algorithms used to sign SAML requests for an identity provider.
type SamlDigestAlgorithm string
The possible digest algorithms used to sign SAML requests for an identity provider.
const (
SamlDigestAlgorithmSha1 SamlDigestAlgorithm = "SHA1" // SHA1.
SamlDigestAlgorithmSha256 SamlDigestAlgorithm = "SHA256" // SHA256.
SamlDigestAlgorithmSha384 SamlDigestAlgorithm = "SHA384" // SHA384.
SamlDigestAlgorithmSha512 SamlDigestAlgorithm = "SHA512" // SHA512.
)
SamlSignatureAlgorithm represents the possible signature algorithms used to sign SAML requests for a Identity Provider.
type SamlSignatureAlgorithm string
The possible signature algorithms used to sign SAML requests for a Identity Provider.
const (
SamlSignatureAlgorithmRsaSha1 SamlSignatureAlgorithm = "RSA_SHA1" // RSA-SHA1.
SamlSignatureAlgorithmRsaSha256 SamlSignatureAlgorithm = "RSA_SHA256" // RSA-SHA256.
SamlSignatureAlgorithmRsaSha384 SamlSignatureAlgorithm = "RSA_SHA384" // RSA-SHA384.
SamlSignatureAlgorithmRsaSha512 SamlSignatureAlgorithm = "RSA_SHA512" // RSA-SHA512.
)
SavedReplyOrder represents ordering options for saved reply connections.
type SavedReplyOrder struct {
// The field to order saved replies by. (Required.)
Field SavedReplyOrderField `json:"field"`
// The ordering direction. (Required.)
Direction OrderDirection `json:"direction"`
}
SavedReplyOrderField represents properties by which saved reply connections can be ordered.
type SavedReplyOrderField string
Properties by which saved reply connections can be ordered.
const (
SavedReplyOrderFieldUpdatedAt SavedReplyOrderField = "UPDATED_AT" // Order saved reply by when they were updated.
)
SearchType represents represents the individual results of a search.
type SearchType string
Represents the individual results of a search.
const (
SearchTypeIssue SearchType = "ISSUE" // Returns results matching issues in repositories.
SearchTypeRepository SearchType = "REPOSITORY" // Returns results matching repositories.
SearchTypeUser SearchType = "USER" // Returns results matching users and organizations on GitHub.
SearchTypeDiscussion SearchType = "DISCUSSION" // Returns matching discussions in repositories.
)
SecurityAdvisoryClassification represents classification of the advisory.
type SecurityAdvisoryClassification string
Classification of the advisory.
const (
SecurityAdvisoryClassificationGeneral SecurityAdvisoryClassification = "GENERAL" // Classification of general advisories.
SecurityAdvisoryClassificationMalware SecurityAdvisoryClassification = "MALWARE" // Classification of malware advisories.
)
SecurityAdvisoryEcosystem represents the possible ecosystems of a security vulnerability's package.
type SecurityAdvisoryEcosystem string
The possible ecosystems of a security vulnerability's package.
const (
SecurityAdvisoryEcosystemComposer SecurityAdvisoryEcosystem = "COMPOSER" // PHP packages hosted at packagist.org.
SecurityAdvisoryEcosystemErlang SecurityAdvisoryEcosystem = "ERLANG" // Erlang/Elixir packages hosted at hex.pm.
SecurityAdvisoryEcosystemActions SecurityAdvisoryEcosystem = "ACTIONS" // GitHub Actions.
SecurityAdvisoryEcosystemGo SecurityAdvisoryEcosystem = "GO" // Go modules.
SecurityAdvisoryEcosystemMaven SecurityAdvisoryEcosystem = "MAVEN" // Java artifacts hosted at the Maven central repository.
SecurityAdvisoryEcosystemNpm SecurityAdvisoryEcosystem = "NPM" // JavaScript packages hosted at npmjs.com.
SecurityAdvisoryEcosystemNuget SecurityAdvisoryEcosystem = "NUGET" // .NET packages hosted at the NuGet Gallery.
SecurityAdvisoryEcosystemPip SecurityAdvisoryEcosystem = "PIP" // Python packages hosted at PyPI.org.
SecurityAdvisoryEcosystemPub SecurityAdvisoryEcosystem = "PUB" // Dart packages hosted at pub.dev.
SecurityAdvisoryEcosystemRubygems SecurityAdvisoryEcosystem = "RUBYGEMS" // Ruby gems hosted at RubyGems.org.
SecurityAdvisoryEcosystemRust SecurityAdvisoryEcosystem = "RUST" // Rust crates.
SecurityAdvisoryEcosystemSwift SecurityAdvisoryEcosystem = "SWIFT" // Swift packages.
)
SecurityAdvisoryIdentifierFilter represents an advisory identifier to filter results on.
type SecurityAdvisoryIdentifierFilter struct {
// The identifier type. (Required.)
Type SecurityAdvisoryIdentifierType `json:"type"`
// The identifier string. Supports exact or partial matching. (Required.)
Value String `json:"value"`
}
SecurityAdvisoryIdentifierType represents identifier formats available for advisories.
type SecurityAdvisoryIdentifierType string
Identifier formats available for advisories.
const (
SecurityAdvisoryIdentifierTypeCve SecurityAdvisoryIdentifierType = "CVE" // Common Vulnerabilities and Exposures Identifier.
SecurityAdvisoryIdentifierTypeGhsa SecurityAdvisoryIdentifierType = "GHSA" // GitHub Security Advisory ID.
)
SecurityAdvisoryOrder represents ordering options for security advisory connections.
type SecurityAdvisoryOrder struct {
// The field to order security advisories by. (Required.)
Field SecurityAdvisoryOrderField `json:"field"`
// The ordering direction. (Required.)
Direction OrderDirection `json:"direction"`
}
SecurityAdvisoryOrderField represents properties by which security advisory connections can be ordered.
type SecurityAdvisoryOrderField string
Properties by which security advisory connections can be ordered.
const (
SecurityAdvisoryOrderFieldPublishedAt SecurityAdvisoryOrderField = "PUBLISHED_AT" // Order advisories by publication time.
SecurityAdvisoryOrderFieldUpdatedAt SecurityAdvisoryOrderField = "UPDATED_AT" // Order advisories by update time.
)
SecurityAdvisorySeverity represents severity of the vulnerability.
type SecurityAdvisorySeverity string
Severity of the vulnerability.
const (
SecurityAdvisorySeverityLow SecurityAdvisorySeverity = "LOW" // Low.
SecurityAdvisorySeverityModerate SecurityAdvisorySeverity = "MODERATE" // Moderate.
SecurityAdvisorySeverityHigh SecurityAdvisorySeverity = "HIGH" // High.
SecurityAdvisorySeverityCritical SecurityAdvisorySeverity = "CRITICAL" // Critical.
)
SecurityVulnerabilityOrder represents ordering options for security vulnerability connections.
type SecurityVulnerabilityOrder struct {
// The field to order security vulnerabilities by. (Required.)
Field SecurityVulnerabilityOrderField `json:"field"`
// The ordering direction. (Required.)
Direction OrderDirection `json:"direction"`
}
SecurityVulnerabilityOrderField represents properties by which security vulnerability connections can be ordered.
type SecurityVulnerabilityOrderField string
Properties by which security vulnerability connections can be ordered.
const (
SecurityVulnerabilityOrderFieldUpdatedAt SecurityVulnerabilityOrderField = "UPDATED_AT" // Order vulnerability by update time.
)
SetEnterpriseIdentityProviderInput is an autogenerated input type of SetEnterpriseIdentityProvider.
type SetEnterpriseIdentityProviderInput struct {
// The ID of the enterprise on which to set an identity provider. (Required.)
EnterpriseID ID `json:"enterpriseId"`
// The URL endpoint for the identity provider's SAML SSO. (Required.)
SsoURL URI `json:"ssoUrl"`
// The x509 certificate used by the identity provider to sign assertions and responses. (Required.)
IdpCertificate String `json:"idpCertificate"`
// The signature algorithm used to sign SAML requests for the identity provider. (Required.)
SignatureMethod SamlSignatureAlgorithm `json:"signatureMethod"`
// The digest algorithm used to sign SAML requests for the identity provider. (Required.)
DigestMethod SamlDigestAlgorithm `json:"digestMethod"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
// The Issuer Entity ID for the SAML identity provider. (Optional.)
Issuer *String `json:"issuer,omitempty"`
}
SetOrganizationInteractionLimitInput is an autogenerated input type of SetOrganizationInteractionLimit.
type SetOrganizationInteractionLimitInput struct {
// The ID of the organization to set a limit for. (Required.)
OrganizationID ID `json:"organizationId"`
// The limit to set. (Required.)
Limit RepositoryInteractionLimit `json:"limit"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
// When this limit should expire. (Optional.)
Expiry *RepositoryInteractionLimitExpiry `json:"expiry,omitempty"`
}
SetRepositoryInteractionLimitInput is an autogenerated input type of SetRepositoryInteractionLimit.
type SetRepositoryInteractionLimitInput struct {
// The ID of the repository to set a limit for. (Required.)
RepositoryID ID `json:"repositoryId"`
// The limit to set. (Required.)
Limit RepositoryInteractionLimit `json:"limit"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
// When this limit should expire. (Optional.)
Expiry *RepositoryInteractionLimitExpiry `json:"expiry,omitempty"`
}
SetUserInteractionLimitInput is an autogenerated input type of SetUserInteractionLimit.
type SetUserInteractionLimitInput struct {
// The ID of the user to set a limit for. (Required.)
UserID ID `json:"userId"`
// The limit to set. (Required.)
Limit RepositoryInteractionLimit `json:"limit"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
// When this limit should expire. (Optional.)
Expiry *RepositoryInteractionLimitExpiry `json:"expiry,omitempty"`
}
SocialAccountProvider represents software or company that hosts social media accounts.
type SocialAccountProvider string
Software or company that hosts social media accounts.
const (
SocialAccountProviderGeneric SocialAccountProvider = "GENERIC" // Catch-all for social media providers that do not yet have specific handling.
SocialAccountProviderFacebook SocialAccountProvider = "FACEBOOK" // Social media and networking website.
SocialAccountProviderHometown SocialAccountProvider = "HOMETOWN" // Fork of Mastodon with a greater focus on local posting.
SocialAccountProviderInstagram SocialAccountProvider = "INSTAGRAM" // Social media website with a focus on photo and video sharing.
SocialAccountProviderLinkedIn SocialAccountProvider = "LINKEDIN" // Professional networking website.
SocialAccountProviderMastodon SocialAccountProvider = "MASTODON" // Open-source federated microblogging service.
SocialAccountProviderReddit SocialAccountProvider = "REDDIT" // Social news aggregation and discussion website.
SocialAccountProviderTwitch SocialAccountProvider = "TWITCH" // Live-streaming service.
SocialAccountProviderTwitter SocialAccountProvider = "TWITTER" // Microblogging website.
SocialAccountProviderYouTube SocialAccountProvider = "YOUTUBE" // Online video platform.
SocialAccountProviderNpm SocialAccountProvider = "NPM" // JavaScript package registry.
)
SponsorAndLifetimeValueOrder represents ordering options for connections to get sponsor entities and associated USD amounts for GitHub Sponsors.
type SponsorAndLifetimeValueOrder struct {
// The field to order results by. (Required.)
Field SponsorAndLifetimeValueOrderField `json:"field"`
// The ordering direction. (Required.)
Direction OrderDirection `json:"direction"`
}
SponsorAndLifetimeValueOrderField represents properties by which sponsor and lifetime value connections can be ordered.
type SponsorAndLifetimeValueOrderField string
Properties by which sponsor and lifetime value connections can be ordered.
const (
SponsorAndLifetimeValueOrderFieldSponsorLogin SponsorAndLifetimeValueOrderField = "SPONSOR_LOGIN" // Order results by the sponsor's login (username).
SponsorAndLifetimeValueOrderFieldSponsorRelevance SponsorAndLifetimeValueOrderField = "SPONSOR_RELEVANCE" // Order results by the sponsor's relevance to the viewer.
SponsorAndLifetimeValueOrderFieldLifetimeValue SponsorAndLifetimeValueOrderField = "LIFETIME_VALUE" // Order results by how much money the sponsor has paid in total.
)
SponsorOrder represents ordering options for connections to get sponsor entities for GitHub Sponsors.
type SponsorOrder struct {
// The field to order sponsor entities by. (Required.)
Field SponsorOrderField `json:"field"`
// The ordering direction. (Required.)
Direction OrderDirection `json:"direction"`
}
SponsorOrderField represents properties by which sponsor connections can be ordered.
type SponsorOrderField string
Properties by which sponsor connections can be ordered.
const (
SponsorOrderFieldLogin SponsorOrderField = "LOGIN" // Order sponsorable entities by login (username).
SponsorOrderFieldRelevance SponsorOrderField = "RELEVANCE" // Order sponsors by their relevance to the viewer.
)
SponsorableOrder represents ordering options for connections to get sponsorable entities for GitHub Sponsors.
type SponsorableOrder struct {
// The field to order sponsorable entities by. (Required.)
Field SponsorableOrderField `json:"field"`
// The ordering direction. (Required.)
Direction OrderDirection `json:"direction"`
}
SponsorableOrderField represents properties by which sponsorable connections can be ordered.
type SponsorableOrderField string
Properties by which sponsorable connections can be ordered.
const (
SponsorableOrderFieldLogin SponsorableOrderField = "LOGIN" // Order sponsorable entities by login (username).
)
SponsorsActivityAction represents the possible actions that GitHub Sponsors activities can represent.
type SponsorsActivityAction string
The possible actions that GitHub Sponsors activities can represent.
const (
SponsorsActivityActionNewSponsorship SponsorsActivityAction = "NEW_SPONSORSHIP" // The activity was starting a sponsorship.
SponsorsActivityActionCancelledSponsorship SponsorsActivityAction = "CANCELLED_SPONSORSHIP" // The activity was cancelling a sponsorship.
SponsorsActivityActionTierChange SponsorsActivityAction = "TIER_CHANGE" // The activity was changing the sponsorship tier, either directly by the sponsor or by a scheduled/pending change.
SponsorsActivityActionRefund SponsorsActivityAction = "REFUND" // The activity was funds being refunded to the sponsor or GitHub.
SponsorsActivityActionPendingChange SponsorsActivityAction = "PENDING_CHANGE" // The activity was scheduling a downgrade or cancellation.
SponsorsActivityActionSponsorMatchDisabled SponsorsActivityAction = "SPONSOR_MATCH_DISABLED" // The activity was disabling matching for a previously matched sponsorship.
)
SponsorsActivityOrder represents ordering options for GitHub Sponsors activity connections.
type SponsorsActivityOrder struct {
// The field to order activity by. (Required.)
Field SponsorsActivityOrderField `json:"field"`
// The ordering direction. (Required.)
Direction OrderDirection `json:"direction"`
}
SponsorsActivityOrderField represents properties by which GitHub Sponsors activity connections can be ordered.
type SponsorsActivityOrderField string
Properties by which GitHub Sponsors activity connections can be ordered.
const (
SponsorsActivityOrderFieldTimestamp SponsorsActivityOrderField = "TIMESTAMP" // Order activities by when they happened.
)
SponsorsActivityPeriod represents the possible time periods for which Sponsors activities can be requested.
type SponsorsActivityPeriod string
The possible time periods for which Sponsors activities can be requested.
const (
SponsorsActivityPeriodDay SponsorsActivityPeriod = "DAY" // The previous calendar day.
SponsorsActivityPeriodWeek SponsorsActivityPeriod = "WEEK" // The previous seven days.
SponsorsActivityPeriodMonth SponsorsActivityPeriod = "MONTH" // The previous thirty days.
SponsorsActivityPeriodAll SponsorsActivityPeriod = "ALL" // Don't restrict the activity to any date range, include all activity.
)
SponsorsCountryOrRegionCode represents represents countries or regions for billing and residence for a GitHub Sponsors profile.
type SponsorsCountryOrRegionCode string
Represents countries or regions for billing and residence for a GitHub Sponsors profile.
const (
SponsorsCountryOrRegionCodeAF SponsorsCountryOrRegionCode = "AF" // Afghanistan.
SponsorsCountryOrRegionCodeAX SponsorsCountryOrRegionCode = "AX" // Åland.
SponsorsCountryOrRegionCodeAL SponsorsCountryOrRegionCode = "AL" // Albania.
SponsorsCountryOrRegionCodeDZ SponsorsCountryOrRegionCode = "DZ" // Algeria.
SponsorsCountryOrRegionCodeAS SponsorsCountryOrRegionCode = "AS" // American Samoa.
SponsorsCountryOrRegionCodeAD SponsorsCountryOrRegionCode = "AD" // Andorra.
SponsorsCountryOrRegionCodeAO SponsorsCountryOrRegionCode = "AO" // Angola.
SponsorsCountryOrRegionCodeAI SponsorsCountryOrRegionCode = "AI" // Anguilla.
SponsorsCountryOrRegionCodeAQ SponsorsCountryOrRegionCode = "AQ" // Antarctica.
SponsorsCountryOrRegionCodeAG SponsorsCountryOrRegionCode = "AG" // Antigua and Barbuda.
SponsorsCountryOrRegionCodeAR SponsorsCountryOrRegionCode = "AR" // Argentina.
SponsorsCountryOrRegionCodeAM SponsorsCountryOrRegionCode = "AM" // Armenia.
SponsorsCountryOrRegionCodeAW SponsorsCountryOrRegionCode = "AW" // Aruba.
SponsorsCountryOrRegionCodeAU SponsorsCountryOrRegionCode = "AU" // Australia.
SponsorsCountryOrRegionCodeAT SponsorsCountryOrRegionCode = "AT" // Austria.
SponsorsCountryOrRegionCodeAZ SponsorsCountryOrRegionCode = "AZ" // Azerbaijan.
SponsorsCountryOrRegionCodeBS SponsorsCountryOrRegionCode = "BS" // Bahamas.
SponsorsCountryOrRegionCodeBH SponsorsCountryOrRegionCode = "BH" // Bahrain.
SponsorsCountryOrRegionCodeBD SponsorsCountryOrRegionCode = "BD" // Bangladesh.
SponsorsCountryOrRegionCodeBB SponsorsCountryOrRegionCode = "BB" // Barbados.
SponsorsCountryOrRegionCodeBY SponsorsCountryOrRegionCode = "BY" // Belarus.
SponsorsCountryOrRegionCodeBE SponsorsCountryOrRegionCode = "BE" // Belgium.
SponsorsCountryOrRegionCodeBZ SponsorsCountryOrRegionCode = "BZ" // Belize.
SponsorsCountryOrRegionCodeBJ SponsorsCountryOrRegionCode = "BJ" // Benin.
SponsorsCountryOrRegionCodeBM SponsorsCountryOrRegionCode = "BM" // Bermuda.
SponsorsCountryOrRegionCodeBT SponsorsCountryOrRegionCode = "BT" // Bhutan.
SponsorsCountryOrRegionCodeBO SponsorsCountryOrRegionCode = "BO" // Bolivia.
SponsorsCountryOrRegionCodeBQ SponsorsCountryOrRegionCode = "BQ" // Bonaire, Sint Eustatius and Saba.
SponsorsCountryOrRegionCodeBA SponsorsCountryOrRegionCode = "BA" // Bosnia and Herzegovina.
SponsorsCountryOrRegionCodeBW SponsorsCountryOrRegionCode = "BW" // Botswana.
SponsorsCountryOrRegionCodeBV SponsorsCountryOrRegionCode = "BV" // Bouvet Island.
SponsorsCountryOrRegionCodeBR SponsorsCountryOrRegionCode = "BR" // Brazil.
SponsorsCountryOrRegionCodeIO SponsorsCountryOrRegionCode = "IO" // British Indian Ocean Territory.
SponsorsCountryOrRegionCodeBN SponsorsCountryOrRegionCode = "BN" // Brunei Darussalam.
SponsorsCountryOrRegionCodeBG SponsorsCountryOrRegionCode = "BG" // Bulgaria.
SponsorsCountryOrRegionCodeBF SponsorsCountryOrRegionCode = "BF" // Burkina Faso.
SponsorsCountryOrRegionCodeBI SponsorsCountryOrRegionCode = "BI" // Burundi.
SponsorsCountryOrRegionCodeKH SponsorsCountryOrRegionCode = "KH" // Cambodia.
SponsorsCountryOrRegionCodeCM SponsorsCountryOrRegionCode = "CM" // Cameroon.
SponsorsCountryOrRegionCodeCA SponsorsCountryOrRegionCode = "CA" // Canada.
SponsorsCountryOrRegionCodeCV SponsorsCountryOrRegionCode = "CV" // Cape Verde.
SponsorsCountryOrRegionCodeKY SponsorsCountryOrRegionCode = "KY" // Cayman Islands.
SponsorsCountryOrRegionCodeCF SponsorsCountryOrRegionCode = "CF" // Central African Republic.
SponsorsCountryOrRegionCodeTD SponsorsCountryOrRegionCode = "TD" // Chad.
SponsorsCountryOrRegionCodeCL SponsorsCountryOrRegionCode = "CL" // Chile.
SponsorsCountryOrRegionCodeCN SponsorsCountryOrRegionCode = "CN" // China.
SponsorsCountryOrRegionCodeCX SponsorsCountryOrRegionCode = "CX" // Christmas Island.
SponsorsCountryOrRegionCodeCC SponsorsCountryOrRegionCode = "CC" // Cocos (Keeling) Islands.
SponsorsCountryOrRegionCodeCO SponsorsCountryOrRegionCode = "CO" // Colombia.
SponsorsCountryOrRegionCodeKM SponsorsCountryOrRegionCode = "KM" // Comoros.
SponsorsCountryOrRegionCodeCG SponsorsCountryOrRegionCode = "CG" // Congo (Brazzaville).
SponsorsCountryOrRegionCodeCD SponsorsCountryOrRegionCode = "CD" // Congo (Kinshasa).
SponsorsCountryOrRegionCodeCK SponsorsCountryOrRegionCode = "CK" // Cook Islands.
SponsorsCountryOrRegionCodeCR SponsorsCountryOrRegionCode = "CR" // Costa Rica.
SponsorsCountryOrRegionCodeCI SponsorsCountryOrRegionCode = "CI" // Côte d'Ivoire.
SponsorsCountryOrRegionCodeHR SponsorsCountryOrRegionCode = "HR" // Croatia.
SponsorsCountryOrRegionCodeCW SponsorsCountryOrRegionCode = "CW" // Curaçao.
SponsorsCountryOrRegionCodeCY SponsorsCountryOrRegionCode = "CY" // Cyprus.
SponsorsCountryOrRegionCodeCZ SponsorsCountryOrRegionCode = "CZ" // Czech Republic.
SponsorsCountryOrRegionCodeDK SponsorsCountryOrRegionCode = "DK" // Denmark.
SponsorsCountryOrRegionCodeDJ SponsorsCountryOrRegionCode = "DJ" // Djibouti.
SponsorsCountryOrRegionCodeDM SponsorsCountryOrRegionCode = "DM" // Dominica.
SponsorsCountryOrRegionCodeDO SponsorsCountryOrRegionCode = "DO" // Dominican Republic.
SponsorsCountryOrRegionCodeEC SponsorsCountryOrRegionCode = "EC" // Ecuador.
SponsorsCountryOrRegionCodeEG SponsorsCountryOrRegionCode = "EG" // Egypt.
SponsorsCountryOrRegionCodeSV SponsorsCountryOrRegionCode = "SV" // El Salvador.
SponsorsCountryOrRegionCodeGQ SponsorsCountryOrRegionCode = "GQ" // Equatorial Guinea.
SponsorsCountryOrRegionCodeER SponsorsCountryOrRegionCode = "ER" // Eritrea.
SponsorsCountryOrRegionCodeEE SponsorsCountryOrRegionCode = "EE" // Estonia.
SponsorsCountryOrRegionCodeET SponsorsCountryOrRegionCode = "ET" // Ethiopia.
SponsorsCountryOrRegionCodeFK SponsorsCountryOrRegionCode = "FK" // Falkland Islands.
SponsorsCountryOrRegionCodeFO SponsorsCountryOrRegionCode = "FO" // Faroe Islands.
SponsorsCountryOrRegionCodeFJ SponsorsCountryOrRegionCode = "FJ" // Fiji.
SponsorsCountryOrRegionCodeFI SponsorsCountryOrRegionCode = "FI" // Finland.
SponsorsCountryOrRegionCodeFR SponsorsCountryOrRegionCode = "FR" // France.
SponsorsCountryOrRegionCodeGF SponsorsCountryOrRegionCode = "GF" // French Guiana.
SponsorsCountryOrRegionCodePF SponsorsCountryOrRegionCode = "PF" // French Polynesia.
SponsorsCountryOrRegionCodeTF SponsorsCountryOrRegionCode = "TF" // French Southern Lands.
SponsorsCountryOrRegionCodeGA SponsorsCountryOrRegionCode = "GA" // Gabon.
SponsorsCountryOrRegionCodeGM SponsorsCountryOrRegionCode = "GM" // Gambia.
SponsorsCountryOrRegionCodeGE SponsorsCountryOrRegionCode = "GE" // Georgia.
SponsorsCountryOrRegionCodeDE SponsorsCountryOrRegionCode = "DE" // Germany.
SponsorsCountryOrRegionCodeGH SponsorsCountryOrRegionCode = "GH" // Ghana.
SponsorsCountryOrRegionCodeGI SponsorsCountryOrRegionCode = "GI" // Gibraltar.
SponsorsCountryOrRegionCodeGR SponsorsCountryOrRegionCode = "GR" // Greece.
SponsorsCountryOrRegionCodeGL SponsorsCountryOrRegionCode = "GL" // Greenland.
SponsorsCountryOrRegionCodeGD SponsorsCountryOrRegionCode = "GD" // Grenada.
SponsorsCountryOrRegionCodeGP SponsorsCountryOrRegionCode = "GP" // Guadeloupe.
SponsorsCountryOrRegionCodeGU SponsorsCountryOrRegionCode = "GU" // Guam.
SponsorsCountryOrRegionCodeGT SponsorsCountryOrRegionCode = "GT" // Guatemala.
SponsorsCountryOrRegionCodeGG SponsorsCountryOrRegionCode = "GG" // Guernsey.
SponsorsCountryOrRegionCodeGN SponsorsCountryOrRegionCode = "GN" // Guinea.
SponsorsCountryOrRegionCodeGW SponsorsCountryOrRegionCode = "GW" // Guinea-Bissau.
SponsorsCountryOrRegionCodeGY SponsorsCountryOrRegionCode = "GY" // Guyana.
SponsorsCountryOrRegionCodeHT SponsorsCountryOrRegionCode = "HT" // Haiti.
SponsorsCountryOrRegionCodeHM SponsorsCountryOrRegionCode = "HM" // Heard and McDonald Islands.
SponsorsCountryOrRegionCodeHN SponsorsCountryOrRegionCode = "HN" // Honduras.
SponsorsCountryOrRegionCodeHK SponsorsCountryOrRegionCode = "HK" // Hong Kong.
SponsorsCountryOrRegionCodeHU SponsorsCountryOrRegionCode = "HU" // Hungary.
SponsorsCountryOrRegionCodeIS SponsorsCountryOrRegionCode = "IS" // Iceland.
SponsorsCountryOrRegionCodeIN SponsorsCountryOrRegionCode = "IN" // India.
SponsorsCountryOrRegionCodeID SponsorsCountryOrRegionCode = "ID" // Indonesia.
SponsorsCountryOrRegionCodeIR SponsorsCountryOrRegionCode = "IR" // Iran.
SponsorsCountryOrRegionCodeIQ SponsorsCountryOrRegionCode = "IQ" // Iraq.
SponsorsCountryOrRegionCodeIE SponsorsCountryOrRegionCode = "IE" // Ireland.
SponsorsCountryOrRegionCodeIM SponsorsCountryOrRegionCode = "IM" // Isle of Man.
SponsorsCountryOrRegionCodeIL SponsorsCountryOrRegionCode = "IL" // Israel.
SponsorsCountryOrRegionCodeIT SponsorsCountryOrRegionCode = "IT" // Italy.
SponsorsCountryOrRegionCodeJM SponsorsCountryOrRegionCode = "JM" // Jamaica.
SponsorsCountryOrRegionCodeJP SponsorsCountryOrRegionCode = "JP" // Japan.
SponsorsCountryOrRegionCodeJE SponsorsCountryOrRegionCode = "JE" // Jersey.
SponsorsCountryOrRegionCodeJO SponsorsCountryOrRegionCode = "JO" // Jordan.
SponsorsCountryOrRegionCodeKZ SponsorsCountryOrRegionCode = "KZ" // Kazakhstan.
SponsorsCountryOrRegionCodeKE SponsorsCountryOrRegionCode = "KE" // Kenya.
SponsorsCountryOrRegionCodeKI SponsorsCountryOrRegionCode = "KI" // Kiribati.
SponsorsCountryOrRegionCodeKR SponsorsCountryOrRegionCode = "KR" // Korea, South.
SponsorsCountryOrRegionCodeKW SponsorsCountryOrRegionCode = "KW" // Kuwait.
SponsorsCountryOrRegionCodeKG SponsorsCountryOrRegionCode = "KG" // Kyrgyzstan.
SponsorsCountryOrRegionCodeLA SponsorsCountryOrRegionCode = "LA" // Laos.
SponsorsCountryOrRegionCodeLV SponsorsCountryOrRegionCode = "LV" // Latvia.
SponsorsCountryOrRegionCodeLB SponsorsCountryOrRegionCode = "LB" // Lebanon.
SponsorsCountryOrRegionCodeLS SponsorsCountryOrRegionCode = "LS" // Lesotho.
SponsorsCountryOrRegionCodeLR SponsorsCountryOrRegionCode = "LR" // Liberia.
SponsorsCountryOrRegionCodeLY SponsorsCountryOrRegionCode = "LY" // Libya.
SponsorsCountryOrRegionCodeLI SponsorsCountryOrRegionCode = "LI" // Liechtenstein.
SponsorsCountryOrRegionCodeLT SponsorsCountryOrRegionCode = "LT" // Lithuania.
SponsorsCountryOrRegionCodeLU SponsorsCountryOrRegionCode = "LU" // Luxembourg.
SponsorsCountryOrRegionCodeMO SponsorsCountryOrRegionCode = "MO" // Macau.
SponsorsCountryOrRegionCodeMK SponsorsCountryOrRegionCode = "MK" // Macedonia.
SponsorsCountryOrRegionCodeMG SponsorsCountryOrRegionCode = "MG" // Madagascar.
SponsorsCountryOrRegionCodeMW SponsorsCountryOrRegionCode = "MW" // Malawi.
SponsorsCountryOrRegionCodeMY SponsorsCountryOrRegionCode = "MY" // Malaysia.
SponsorsCountryOrRegionCodeMV SponsorsCountryOrRegionCode = "MV" // Maldives.
SponsorsCountryOrRegionCodeML SponsorsCountryOrRegionCode = "ML" // Mali.
SponsorsCountryOrRegionCodeMT SponsorsCountryOrRegionCode = "MT" // Malta.
SponsorsCountryOrRegionCodeMH SponsorsCountryOrRegionCode = "MH" // Marshall Islands.
SponsorsCountryOrRegionCodeMQ SponsorsCountryOrRegionCode = "MQ" // Martinique.
SponsorsCountryOrRegionCodeMR SponsorsCountryOrRegionCode = "MR" // Mauritania.
SponsorsCountryOrRegionCodeMU SponsorsCountryOrRegionCode = "MU" // Mauritius.
SponsorsCountryOrRegionCodeYT SponsorsCountryOrRegionCode = "YT" // Mayotte.
SponsorsCountryOrRegionCodeMX SponsorsCountryOrRegionCode = "MX" // Mexico.
SponsorsCountryOrRegionCodeFM SponsorsCountryOrRegionCode = "FM" // Micronesia.
SponsorsCountryOrRegionCodeMD SponsorsCountryOrRegionCode = "MD" // Moldova.
SponsorsCountryOrRegionCodeMC SponsorsCountryOrRegionCode = "MC" // Monaco.
SponsorsCountryOrRegionCodeMN SponsorsCountryOrRegionCode = "MN" // Mongolia.
SponsorsCountryOrRegionCodeME SponsorsCountryOrRegionCode = "ME" // Montenegro.
SponsorsCountryOrRegionCodeMS SponsorsCountryOrRegionCode = "MS" // Montserrat.
SponsorsCountryOrRegionCodeMA SponsorsCountryOrRegionCode = "MA" // Morocco.
SponsorsCountryOrRegionCodeMZ SponsorsCountryOrRegionCode = "MZ" // Mozambique.
SponsorsCountryOrRegionCodeMM SponsorsCountryOrRegionCode = "MM" // Myanmar.
SponsorsCountryOrRegionCodeNA SponsorsCountryOrRegionCode = "NA" // Namibia.
SponsorsCountryOrRegionCodeNR SponsorsCountryOrRegionCode = "NR" // Nauru.
SponsorsCountryOrRegionCodeNP SponsorsCountryOrRegionCode = "NP" // Nepal.
SponsorsCountryOrRegionCodeNL SponsorsCountryOrRegionCode = "NL" // Netherlands.
SponsorsCountryOrRegionCodeNC SponsorsCountryOrRegionCode = "NC" // New Caledonia.
SponsorsCountryOrRegionCodeNZ SponsorsCountryOrRegionCode = "NZ" // New Zealand.
SponsorsCountryOrRegionCodeNI SponsorsCountryOrRegionCode = "NI" // Nicaragua.
SponsorsCountryOrRegionCodeNE SponsorsCountryOrRegionCode = "NE" // Niger.
SponsorsCountryOrRegionCodeNG SponsorsCountryOrRegionCode = "NG" // Nigeria.
SponsorsCountryOrRegionCodeNU SponsorsCountryOrRegionCode = "NU" // Niue.
SponsorsCountryOrRegionCodeNF SponsorsCountryOrRegionCode = "NF" // Norfolk Island.
SponsorsCountryOrRegionCodeMP SponsorsCountryOrRegionCode = "MP" // Northern Mariana Islands.
SponsorsCountryOrRegionCodeNO SponsorsCountryOrRegionCode = "NO" // Norway.
SponsorsCountryOrRegionCodeOM SponsorsCountryOrRegionCode = "OM" // Oman.
SponsorsCountryOrRegionCodePK SponsorsCountryOrRegionCode = "PK" // Pakistan.
SponsorsCountryOrRegionCodePW SponsorsCountryOrRegionCode = "PW" // Palau.
SponsorsCountryOrRegionCodePS SponsorsCountryOrRegionCode = "PS" // Palestine.
SponsorsCountryOrRegionCodePA SponsorsCountryOrRegionCode = "PA" // Panama.
SponsorsCountryOrRegionCodePG SponsorsCountryOrRegionCode = "PG" // Papua New Guinea.
SponsorsCountryOrRegionCodePY SponsorsCountryOrRegionCode = "PY" // Paraguay.
SponsorsCountryOrRegionCodePE SponsorsCountryOrRegionCode = "PE" // Peru.
SponsorsCountryOrRegionCodePH SponsorsCountryOrRegionCode = "PH" // Philippines.
SponsorsCountryOrRegionCodePN SponsorsCountryOrRegionCode = "PN" // Pitcairn.
SponsorsCountryOrRegionCodePL SponsorsCountryOrRegionCode = "PL" // Poland.
SponsorsCountryOrRegionCodePT SponsorsCountryOrRegionCode = "PT" // Portugal.
SponsorsCountryOrRegionCodePR SponsorsCountryOrRegionCode = "PR" // Puerto Rico.
SponsorsCountryOrRegionCodeQA SponsorsCountryOrRegionCode = "QA" // Qatar.
SponsorsCountryOrRegionCodeRE SponsorsCountryOrRegionCode = "RE" // Reunion.
SponsorsCountryOrRegionCodeRO SponsorsCountryOrRegionCode = "RO" // Romania.
SponsorsCountryOrRegionCodeRU SponsorsCountryOrRegionCode = "RU" // Russian Federation.
SponsorsCountryOrRegionCodeRW SponsorsCountryOrRegionCode = "RW" // Rwanda.
SponsorsCountryOrRegionCodeBL SponsorsCountryOrRegionCode = "BL" // Saint Barthélemy.
SponsorsCountryOrRegionCodeSH SponsorsCountryOrRegionCode = "SH" // Saint Helena.
SponsorsCountryOrRegionCodeKN SponsorsCountryOrRegionCode = "KN" // Saint Kitts and Nevis.
SponsorsCountryOrRegionCodeLC SponsorsCountryOrRegionCode = "LC" // Saint Lucia.
SponsorsCountryOrRegionCodeMF SponsorsCountryOrRegionCode = "MF" // Saint Martin (French part).
SponsorsCountryOrRegionCodePM SponsorsCountryOrRegionCode = "PM" // Saint Pierre and Miquelon.
SponsorsCountryOrRegionCodeVC SponsorsCountryOrRegionCode = "VC" // Saint Vincent and the Grenadines.
SponsorsCountryOrRegionCodeWS SponsorsCountryOrRegionCode = "WS" // Samoa.
SponsorsCountryOrRegionCodeSM SponsorsCountryOrRegionCode = "SM" // San Marino.
SponsorsCountryOrRegionCodeST SponsorsCountryOrRegionCode = "ST" // Sao Tome and Principe.
SponsorsCountryOrRegionCodeSA SponsorsCountryOrRegionCode = "SA" // Saudi Arabia.
SponsorsCountryOrRegionCodeSN SponsorsCountryOrRegionCode = "SN" // Senegal.
SponsorsCountryOrRegionCodeRS SponsorsCountryOrRegionCode = "RS" // Serbia.
SponsorsCountryOrRegionCodeSC SponsorsCountryOrRegionCode = "SC" // Seychelles.
SponsorsCountryOrRegionCodeSL SponsorsCountryOrRegionCode = "SL" // Sierra Leone.
SponsorsCountryOrRegionCodeSG SponsorsCountryOrRegionCode = "SG" // Singapore.
SponsorsCountryOrRegionCodeSX SponsorsCountryOrRegionCode = "SX" // Sint Maarten (Dutch part).
SponsorsCountryOrRegionCodeSK SponsorsCountryOrRegionCode = "SK" // Slovakia.
SponsorsCountryOrRegionCodeSI SponsorsCountryOrRegionCode = "SI" // Slovenia.
SponsorsCountryOrRegionCodeSB SponsorsCountryOrRegionCode = "SB" // Solomon Islands.
SponsorsCountryOrRegionCodeSO SponsorsCountryOrRegionCode = "SO" // Somalia.
SponsorsCountryOrRegionCodeZA SponsorsCountryOrRegionCode = "ZA" // South Africa.
SponsorsCountryOrRegionCodeGS SponsorsCountryOrRegionCode = "GS" // South Georgia and South Sandwich Islands.
SponsorsCountryOrRegionCodeSS SponsorsCountryOrRegionCode = "SS" // South Sudan.
SponsorsCountryOrRegionCodeES SponsorsCountryOrRegionCode = "ES" // Spain.
SponsorsCountryOrRegionCodeLK SponsorsCountryOrRegionCode = "LK" // Sri Lanka.
SponsorsCountryOrRegionCodeSD SponsorsCountryOrRegionCode = "SD" // Sudan.
SponsorsCountryOrRegionCodeSR SponsorsCountryOrRegionCode = "SR" // Suriname.
SponsorsCountryOrRegionCodeSJ SponsorsCountryOrRegionCode = "SJ" // Svalbard and Jan Mayen Islands.
SponsorsCountryOrRegionCodeSZ SponsorsCountryOrRegionCode = "SZ" // Swaziland.
SponsorsCountryOrRegionCodeSE SponsorsCountryOrRegionCode = "SE" // Sweden.
SponsorsCountryOrRegionCodeCH SponsorsCountryOrRegionCode = "CH" // Switzerland.
SponsorsCountryOrRegionCodeTW SponsorsCountryOrRegionCode = "TW" // Taiwan.
SponsorsCountryOrRegionCodeTJ SponsorsCountryOrRegionCode = "TJ" // Tajikistan.
SponsorsCountryOrRegionCodeTZ SponsorsCountryOrRegionCode = "TZ" // Tanzania.
SponsorsCountryOrRegionCodeTH SponsorsCountryOrRegionCode = "TH" // Thailand.
SponsorsCountryOrRegionCodeTL SponsorsCountryOrRegionCode = "TL" // Timor-Leste.
SponsorsCountryOrRegionCodeTG SponsorsCountryOrRegionCode = "TG" // Togo.
SponsorsCountryOrRegionCodeTK SponsorsCountryOrRegionCode = "TK" // Tokelau.
SponsorsCountryOrRegionCodeTO SponsorsCountryOrRegionCode = "TO" // Tonga.
SponsorsCountryOrRegionCodeTT SponsorsCountryOrRegionCode = "TT" // Trinidad and Tobago.
SponsorsCountryOrRegionCodeTN SponsorsCountryOrRegionCode = "TN" // Tunisia.
SponsorsCountryOrRegionCodeTR SponsorsCountryOrRegionCode = "TR" // Türkiye.
SponsorsCountryOrRegionCodeTM SponsorsCountryOrRegionCode = "TM" // Turkmenistan.
SponsorsCountryOrRegionCodeTC SponsorsCountryOrRegionCode = "TC" // Turks and Caicos Islands.
SponsorsCountryOrRegionCodeTV SponsorsCountryOrRegionCode = "TV" // Tuvalu.
SponsorsCountryOrRegionCodeUG SponsorsCountryOrRegionCode = "UG" // Uganda.
SponsorsCountryOrRegionCodeUA SponsorsCountryOrRegionCode = "UA" // Ukraine.
SponsorsCountryOrRegionCodeAE SponsorsCountryOrRegionCode = "AE" // United Arab Emirates.
SponsorsCountryOrRegionCodeGB SponsorsCountryOrRegionCode = "GB" // United Kingdom.
SponsorsCountryOrRegionCodeUM SponsorsCountryOrRegionCode = "UM" // United States Minor Outlying Islands.
SponsorsCountryOrRegionCodeUS SponsorsCountryOrRegionCode = "US" // United States of America.
SponsorsCountryOrRegionCodeUY SponsorsCountryOrRegionCode = "UY" // Uruguay.
SponsorsCountryOrRegionCodeUZ SponsorsCountryOrRegionCode = "UZ" // Uzbekistan.
SponsorsCountryOrRegionCodeVU SponsorsCountryOrRegionCode = "VU" // Vanuatu.
SponsorsCountryOrRegionCodeVA SponsorsCountryOrRegionCode = "VA" // Vatican City.
SponsorsCountryOrRegionCodeVE SponsorsCountryOrRegionCode = "VE" // Venezuela.
SponsorsCountryOrRegionCodeVN SponsorsCountryOrRegionCode = "VN" // Vietnam.
SponsorsCountryOrRegionCodeVG SponsorsCountryOrRegionCode = "VG" // Virgin Islands, British.
SponsorsCountryOrRegionCodeVI SponsorsCountryOrRegionCode = "VI" // Virgin Islands, U.S.
SponsorsCountryOrRegionCodeWF SponsorsCountryOrRegionCode = "WF" // Wallis and Futuna Islands.
SponsorsCountryOrRegionCodeEH SponsorsCountryOrRegionCode = "EH" // Western Sahara.
SponsorsCountryOrRegionCodeYE SponsorsCountryOrRegionCode = "YE" // Yemen.
SponsorsCountryOrRegionCodeZM SponsorsCountryOrRegionCode = "ZM" // Zambia.
SponsorsCountryOrRegionCodeZW SponsorsCountryOrRegionCode = "ZW" // Zimbabwe.
)
SponsorsGoalKind represents the different kinds of goals a GitHub Sponsors member can have.
type SponsorsGoalKind string
The different kinds of goals a GitHub Sponsors member can have.
const (
SponsorsGoalKindTotalSponsorsCount SponsorsGoalKind = "TOTAL_SPONSORS_COUNT" // The goal is about reaching a certain number of sponsors.
SponsorsGoalKindMonthlySponsorshipAmount SponsorsGoalKind = "MONTHLY_SPONSORSHIP_AMOUNT" // The goal is about getting a certain amount in USD from sponsorships each month.
)
SponsorsListingFeaturedItemFeatureableType represents the different kinds of records that can be featured on a GitHub Sponsors profile page.
type SponsorsListingFeaturedItemFeatureableType string
The different kinds of records that can be featured on a GitHub Sponsors profile page.
const (
SponsorsListingFeaturedItemFeatureableTypeRepository SponsorsListingFeaturedItemFeatureableType = "REPOSITORY" // A repository owned by the user or organization with the GitHub Sponsors profile.
SponsorsListingFeaturedItemFeatureableTypeUser SponsorsListingFeaturedItemFeatureableType = "USER" // A user who belongs to the organization with the GitHub Sponsors profile.
)
SponsorsTierOrder represents ordering options for Sponsors tiers connections.
type SponsorsTierOrder struct {
// The field to order tiers by. (Required.)
Field SponsorsTierOrderField `json:"field"`
// The ordering direction. (Required.)
Direction OrderDirection `json:"direction"`
}
SponsorsTierOrderField represents properties by which Sponsors tiers connections can be ordered.
type SponsorsTierOrderField string
Properties by which Sponsors tiers connections can be ordered.
const (
SponsorsTierOrderFieldCreatedAt SponsorsTierOrderField = "CREATED_AT" // Order tiers by creation time.
SponsorsTierOrderFieldMonthlyPriceInCents SponsorsTierOrderField = "MONTHLY_PRICE_IN_CENTS" // Order tiers by their monthly price in cents.
)
SponsorshipNewsletterOrder represents ordering options for sponsorship newsletter connections.
type SponsorshipNewsletterOrder struct {
// The field to order sponsorship newsletters by. (Required.)
Field SponsorshipNewsletterOrderField `json:"field"`
// The ordering direction. (Required.)
Direction OrderDirection `json:"direction"`
}
SponsorshipNewsletterOrderField represents properties by which sponsorship update connections can be ordered.
type SponsorshipNewsletterOrderField string
Properties by which sponsorship update connections can be ordered.
const (
SponsorshipNewsletterOrderFieldCreatedAt SponsorshipNewsletterOrderField = "CREATED_AT" // Order sponsorship newsletters by when they were created.
)
SponsorshipOrder represents ordering options for sponsorship connections.
type SponsorshipOrder struct {
// The field to order sponsorship by. (Required.)
Field SponsorshipOrderField `json:"field"`
// The ordering direction. (Required.)
Direction OrderDirection `json:"direction"`
}
SponsorshipOrderField represents properties by which sponsorship connections can be ordered.
type SponsorshipOrderField string
Properties by which sponsorship connections can be ordered.
const (
SponsorshipOrderFieldCreatedAt SponsorshipOrderField = "CREATED_AT" // Order sponsorship by creation time.
)
SponsorshipPaymentSource represents how payment was made for funding a GitHub Sponsors sponsorship.
type SponsorshipPaymentSource string
How payment was made for funding a GitHub Sponsors sponsorship.
const (
SponsorshipPaymentSourceGitHub SponsorshipPaymentSource = "GITHUB" // Payment was made through GitHub.
SponsorshipPaymentSourcePatreon SponsorshipPaymentSource = "PATREON" // Payment was made through Patreon.
)
SponsorshipPrivacy represents the privacy of a sponsorship.
type SponsorshipPrivacy string
The privacy of a sponsorship.
const (
SponsorshipPrivacyPublic SponsorshipPrivacy = "PUBLIC" // Public.
SponsorshipPrivacyPrivate SponsorshipPrivacy = "PRIVATE" // Private.
)
SquashMergeCommitMessage represents the possible default commit messages for squash merges.
type SquashMergeCommitMessage string
The possible default commit messages for squash merges.
const (
SquashMergeCommitMessagePrBody SquashMergeCommitMessage = "PR_BODY" // Default to the pull request's body.
SquashMergeCommitMessageCommitMessages SquashMergeCommitMessage = "COMMIT_MESSAGES" // Default to the branch's commit messages.
SquashMergeCommitMessageBlank SquashMergeCommitMessage = "BLANK" // Default to a blank commit message.
)
SquashMergeCommitTitle represents the possible default commit titles for squash merges.
type SquashMergeCommitTitle string
The possible default commit titles for squash merges.
const (
SquashMergeCommitTitlePrTitle SquashMergeCommitTitle = "PR_TITLE" // Default to the pull request's title.
SquashMergeCommitTitleCommitOrPrTitle SquashMergeCommitTitle = "COMMIT_OR_PR_TITLE" // Default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
)
StarOrder represents ways in which star connections can be ordered.
type StarOrder struct {
// The field in which to order nodes by. (Required.)
Field StarOrderField `json:"field"`
// The direction in which to order nodes. (Required.)
Direction OrderDirection `json:"direction"`
}
StarOrderField represents properties by which star connections can be ordered.
type StarOrderField string
Properties by which star connections can be ordered.
const (
StarOrderFieldStarredAt StarOrderField = "STARRED_AT" // Allows ordering a list of stars by when they were created.
)
StartOrganizationMigrationInput is an autogenerated input type of StartOrganizationMigration.
type StartOrganizationMigrationInput struct {
// The URL of the organization to migrate. (Required.)
SourceOrgURL URI `json:"sourceOrgUrl"`
// The name of the target organization. (Required.)
TargetOrgName String `json:"targetOrgName"`
// The ID of the enterprise the target organization belongs to. (Required.)
TargetEnterpriseID ID `json:"targetEnterpriseId"`
// The migration source access token. (Required.)
SourceAccessToken String `json:"sourceAccessToken"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
StartRepositoryMigrationInput is an autogenerated input type of StartRepositoryMigration.
type StartRepositoryMigrationInput struct {
// The ID of the migration source. (Required.)
SourceID ID `json:"sourceId"`
// The ID of the organization that will own the imported repository. (Required.)
OwnerID ID `json:"ownerId"`
// The URL of the source repository. (Required.)
SourceRepositoryURL URI `json:"sourceRepositoryUrl"`
// The name of the imported repository. (Required.)
RepositoryName String `json:"repositoryName"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
// Whether to continue the migration on error. Defaults to `true`. (Optional.)
ContinueOnError *Boolean `json:"continueOnError,omitempty"`
// The signed URL to access the user-uploaded git archive. (Optional.)
GitArchiveURL *String `json:"gitArchiveUrl,omitempty"`
// The signed URL to access the user-uploaded metadata archive. (Optional.)
MetadataArchiveURL *String `json:"metadataArchiveUrl,omitempty"`
// The migration source access token. (Optional.)
AccessToken *String `json:"accessToken,omitempty"`
// The GitHub personal access token of the user importing to the target repository. (Optional.)
GitHubPat *String `json:"githubPat,omitempty"`
// Whether to skip migrating releases for the repository. (Optional.)
SkipReleases *Boolean `json:"skipReleases,omitempty"`
// The visibility of the imported repository. (Optional.)
TargetRepoVisibility *String `json:"targetRepoVisibility,omitempty"`
// Whether to lock the source repository. (Optional.)
LockSource *Boolean `json:"lockSource,omitempty"`
}
StatusCheckConfigurationInput represents required status check.
type StatusCheckConfigurationInput struct {
// The status check context name that must be present on the commit. (Required.)
Context String `json:"context"`
// The optional integration ID that this status check must originate from. (Optional.)
IntegrationID *Int `json:"integrationId,omitempty"`
}
StatusState represents the possible commit status states.
type StatusState string
The possible commit status states.
const (
StatusStateExpected StatusState = "EXPECTED" // Status is expected.
StatusStateError StatusState = "ERROR" // Status is errored.
StatusStateFailure StatusState = "FAILURE" // Status is failing.
StatusStatePending StatusState = "PENDING" // Status is pending.
StatusStateSuccess StatusState = "SUCCESS" // Status is successful.
)
String represents textual data as UTF-8 character sequences. This type is most often used by GraphQL to represent free-form human-readable text.
type String graphql.String
func NewString(v String) *String
NewString is a helper to make a new *String.
SubmitPullRequestReviewInput is an autogenerated input type of SubmitPullRequestReview.
type SubmitPullRequestReviewInput struct {
// The event to send to the Pull Request Review. (Required.)
Event PullRequestReviewEvent `json:"event"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
// The Pull Request ID to submit any pending reviews. (Optional.)
PullRequestID *ID `json:"pullRequestId,omitempty"`
// The Pull Request Review ID to submit. (Optional.)
PullRequestReviewID *ID `json:"pullRequestReviewId,omitempty"`
// The text field to set on the Pull Request Review. (Optional.)
Body *String `json:"body,omitempty"`
}
SubscriptionState represents the possible states of a subscription.
type SubscriptionState string
The possible states of a subscription.
const (
SubscriptionStateUnsubscribed SubscriptionState = "UNSUBSCRIBED" // The User is only notified when participating or @mentioned.
SubscriptionStateSubscribed SubscriptionState = "SUBSCRIBED" // The User is notified of all conversations.
SubscriptionStateIgnored SubscriptionState = "IGNORED" // The User is never notified.
)
TagNamePatternParametersInput represents parameters to be used for the tag_name_pattern rule.
type TagNamePatternParametersInput struct {
// The operator to use for matching. (Required.)
Operator String `json:"operator"`
// The pattern to match with. (Required.)
Pattern String `json:"pattern"`
// How this rule will appear to users. (Optional.)
Name *String `json:"name,omitempty"`
// If true, the rule will fail if the pattern matches. (Optional.)
Negate *Boolean `json:"negate,omitempty"`
}
TeamDiscussionCommentOrder represents ways in which team discussion comment connections can be ordered.
type TeamDiscussionCommentOrder struct {
// The field by which to order nodes. (Required.)
Field TeamDiscussionCommentOrderField `json:"field"`
// The direction in which to order nodes. (Required.)
Direction OrderDirection `json:"direction"`
}
TeamDiscussionCommentOrderField represents properties by which team discussion comment connections can be ordered.
type TeamDiscussionCommentOrderField string
Properties by which team discussion comment connections can be ordered.
const (
TeamDiscussionCommentOrderFieldNumber TeamDiscussionCommentOrderField = "NUMBER" // Allows sequential ordering of team discussion comments (which is equivalent to chronological ordering).
)
TeamDiscussionOrder represents ways in which team discussion connections can be ordered.
type TeamDiscussionOrder struct {
// The field by which to order nodes. (Required.)
Field TeamDiscussionOrderField `json:"field"`
// The direction in which to order nodes. (Required.)
Direction OrderDirection `json:"direction"`
}
TeamDiscussionOrderField represents properties by which team discussion connections can be ordered.
type TeamDiscussionOrderField string
Properties by which team discussion connections can be ordered.
const (
TeamDiscussionOrderFieldCreatedAt TeamDiscussionOrderField = "CREATED_AT" // Allows chronological ordering of team discussions.
)
TeamMemberOrder represents ordering options for team member connections.
type TeamMemberOrder struct {
// The field to order team members by. (Required.)
Field TeamMemberOrderField `json:"field"`
// The ordering direction. (Required.)
Direction OrderDirection `json:"direction"`
}
TeamMemberOrderField represents properties by which team member connections can be ordered.
type TeamMemberOrderField string
Properties by which team member connections can be ordered.
const (
TeamMemberOrderFieldLogin TeamMemberOrderField = "LOGIN" // Order team members by login.
TeamMemberOrderFieldCreatedAt TeamMemberOrderField = "CREATED_AT" // Order team members by creation time.
)
TeamMemberRole represents the possible team member roles; either 'maintainer' or 'member'.
type TeamMemberRole string
The possible team member roles; either 'maintainer' or 'member'.
const (
TeamMemberRoleMaintainer TeamMemberRole = "MAINTAINER" // A team maintainer has permission to add and remove team members.
TeamMemberRoleMember TeamMemberRole = "MEMBER" // A team member has no administrative permissions on the team.
)
TeamMembershipType represents defines which types of team members are included in the returned list. Can be one of IMMEDIATE, CHILD_TEAM or ALL.
type TeamMembershipType string
Defines which types of team members are included in the returned list. Can be one of IMMEDIATE, CHILD_TEAM or ALL.
const (
TeamMembershipTypeImmediate TeamMembershipType = "IMMEDIATE" // Includes only immediate members of the team.
TeamMembershipTypeChildTeam TeamMembershipType = "CHILD_TEAM" // Includes only child team members for the team.
TeamMembershipTypeAll TeamMembershipType = "ALL" // Includes immediate and child team members for the team.
)
TeamNotificationSetting represents the possible team notification values.
type TeamNotificationSetting string
The possible team notification values.
const (
TeamNotificationSettingNotificationsEnabled TeamNotificationSetting = "NOTIFICATIONS_ENABLED" // Everyone will receive notifications when the team is @mentioned.
TeamNotificationSettingNotificationsDisabled TeamNotificationSetting = "NOTIFICATIONS_DISABLED" // No one will receive notifications.
)
TeamOrder represents ways in which team connections can be ordered.
type TeamOrder struct {
// The field in which to order nodes by. (Required.)
Field TeamOrderField `json:"field"`
// The direction in which to order nodes. (Required.)
Direction OrderDirection `json:"direction"`
}
TeamOrderField represents properties by which team connections can be ordered.
type TeamOrderField string
Properties by which team connections can be ordered.
const (
TeamOrderFieldName TeamOrderField = "NAME" // Allows ordering a list of teams by name.
)
TeamPrivacy represents the possible team privacy values.
type TeamPrivacy string
The possible team privacy values.
const (
TeamPrivacySecret TeamPrivacy = "SECRET" // A secret team can only be seen by its members.
TeamPrivacyVisible TeamPrivacy = "VISIBLE" // A visible team can be seen and @mentioned by every member of the organization.
)
TeamRepositoryOrder represents ordering options for team repository connections.
type TeamRepositoryOrder struct {
// The field to order repositories by. (Required.)
Field TeamRepositoryOrderField `json:"field"`
// The ordering direction. (Required.)
Direction OrderDirection `json:"direction"`
}
TeamRepositoryOrderField represents properties by which team repository connections can be ordered.
type TeamRepositoryOrderField string
Properties by which team repository connections can be ordered.
const (
TeamRepositoryOrderFieldCreatedAt TeamRepositoryOrderField = "CREATED_AT" // Order repositories by creation time.
TeamRepositoryOrderFieldUpdatedAt TeamRepositoryOrderField = "UPDATED_AT" // Order repositories by update time.
TeamRepositoryOrderFieldPushedAt TeamRepositoryOrderField = "PUSHED_AT" // Order repositories by push time.
TeamRepositoryOrderFieldName TeamRepositoryOrderField = "NAME" // Order repositories by name.
TeamRepositoryOrderFieldPermission TeamRepositoryOrderField = "PERMISSION" // Order repositories by permission.
TeamRepositoryOrderFieldStargazers TeamRepositoryOrderField = "STARGAZERS" // Order repositories by number of stargazers.
)
TeamReviewAssignmentAlgorithm represents the possible team review assignment algorithms.
type TeamReviewAssignmentAlgorithm string
The possible team review assignment algorithms.
const (
TeamReviewAssignmentAlgorithmRoundRobin TeamReviewAssignmentAlgorithm = "ROUND_ROBIN" // Alternate reviews between each team member.
TeamReviewAssignmentAlgorithmLoadBalance TeamReviewAssignmentAlgorithm = "LOAD_BALANCE" // Balance review load across the entire team.
)
TeamRole represents the role of a user on a team.
type TeamRole string
The role of a user on a team.
const (
TeamRoleAdmin TeamRole = "ADMIN" // User has admin rights on the team.
TeamRoleMember TeamRole = "MEMBER" // User is a member of the team.
)
ThreadSubscriptionFormAction represents the possible states of a thread subscription form action.
type ThreadSubscriptionFormAction string
The possible states of a thread subscription form action.
const (
ThreadSubscriptionFormActionNone ThreadSubscriptionFormAction = "NONE" // The User cannot subscribe or unsubscribe to the thread.
ThreadSubscriptionFormActionSubscribe ThreadSubscriptionFormAction = "SUBSCRIBE" // The User can subscribe to the thread.
ThreadSubscriptionFormActionUnsubscribe ThreadSubscriptionFormAction = "UNSUBSCRIBE" // The User can unsubscribe to the thread.
)
ThreadSubscriptionState represents the possible states of a subscription.
type ThreadSubscriptionState string
The possible states of a subscription.
const (
ThreadSubscriptionState = "UNAVAILABLE" // The subscription status is currently unavailable.
ThreadSubscriptionStateDisabled ThreadSubscriptionState = "DISABLED" // The subscription status is currently disabled.
ThreadSubscriptionStateIgnoringList ThreadSubscriptionState = "IGNORING_LIST" // The User is never notified because they are ignoring the list.
ThreadSubscriptionStateSubscribedToThreadEvents ThreadSubscriptionState = "SUBSCRIBED_TO_THREAD_EVENTS" // The User is notified because they chose custom settings for this thread.
ThreadSubscriptionStateIgnoringThread ThreadSubscriptionState = "IGNORING_THREAD" // The User is never notified because they are ignoring the thread.
ThreadSubscriptionStateSubscribedToList ThreadSubscriptionState = "SUBSCRIBED_TO_LIST" // The User is notified becuase they are watching the list.
ThreadSubscriptionStateSubscribedToThreadType ThreadSubscriptionState = "SUBSCRIBED_TO_THREAD_TYPE" // The User is notified because they chose custom settings for this thread.
ThreadSubscriptionStateSubscribedToThread ThreadSubscriptionState = "SUBSCRIBED_TO_THREAD" // The User is notified because they are subscribed to the thread.
ThreadSubscriptionStateNone ThreadSubscriptionState = "NONE" // The User is not recieving notifications from this thread.
)
TopicSuggestionDeclineReason represents reason that the suggested topic is declined.
type TopicSuggestionDeclineReason string
Reason that the suggested topic is declined.
const (
TopicSuggestionDeclineReasonNotRelevant TopicSuggestionDeclineReason = "NOT_RELEVANT" // The suggested topic is not relevant to the repository.
TopicSuggestionDeclineReasonTooSpecific TopicSuggestionDeclineReason = "TOO_SPECIFIC" // The suggested topic is too specific for the repository (e.g. #ruby-on-rails-version-4-2-1).
TopicSuggestionDeclineReasonPersonalPreference TopicSuggestionDeclineReason = "PERSONAL_PREFERENCE" // The viewer does not like the suggested topic.
TopicSuggestionDeclineReasonTooGeneral TopicSuggestionDeclineReason = "TOO_GENERAL" // The suggested topic is too general for the repository.
)
TrackedIssueStates represents the possible states of a tracked issue.
type TrackedIssueStates string
The possible states of a tracked issue.
const (
TrackedIssueStatesOpen TrackedIssueStates = "OPEN" // The tracked issue is open.
TrackedIssueStatesClosed TrackedIssueStates = "CLOSED" // The tracked issue is closed.
)
TransferEnterpriseOrganizationInput is an autogenerated input type of TransferEnterpriseOrganization.
type TransferEnterpriseOrganizationInput struct {
// The ID of the organization to transfer. (Required.)
OrganizationID ID `json:"organizationId"`
// The ID of the enterprise where the organization should be transferred. (Required.)
DestinationEnterpriseID ID `json:"destinationEnterpriseId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
TransferIssueInput is an autogenerated input type of TransferIssue.
type TransferIssueInput struct {
// The Node ID of the issue to be transferred. (Required.)
IssueID ID `json:"issueId"`
// The Node ID of the repository the issue should be transferred to. (Required.)
RepositoryID ID `json:"repositoryId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
// Whether to create labels if they don't exist in the target repository (matched by name). (Optional.)
CreateLabelsIfMissing *Boolean `json:"createLabelsIfMissing,omitempty"`
}
URI is an RFC 3986, RFC 3987, and RFC 6570 (level 4) compliant URI.
type URI struct{ *url.URL }
func NewURI(v URI) *URI
NewURI is a helper to make a new *URI.
func (u URI) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaler interface. The URI is a quoted string.
func (u *URI) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaler interface. The URI is expected to be a quoted string.
UnarchiveProjectV2ItemInput is an autogenerated input type of UnarchiveProjectV2Item.
type UnarchiveProjectV2ItemInput struct {
// The ID of the Project to archive the item from. (Required.)
ProjectID ID `json:"projectId"`
// The ID of the ProjectV2Item to unarchive. (Required.)
ItemID ID `json:"itemId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
UnarchiveRepositoryInput is an autogenerated input type of UnarchiveRepository.
type UnarchiveRepositoryInput struct {
// The ID of the repository to unarchive. (Required.)
RepositoryID ID `json:"repositoryId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
UnfollowOrganizationInput is an autogenerated input type of UnfollowOrganization.
type UnfollowOrganizationInput struct {
// ID of the organization to unfollow. (Required.)
OrganizationID ID `json:"organizationId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
UnfollowUserInput is an autogenerated input type of UnfollowUser.
type UnfollowUserInput struct {
// ID of the user to unfollow. (Required.)
UserID ID `json:"userId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
UnlinkProjectV2FromRepositoryInput is an autogenerated input type of UnlinkProjectV2FromRepository.
type UnlinkProjectV2FromRepositoryInput struct {
// The ID of the project to unlink from the repository. (Required.)
ProjectID ID `json:"projectId"`
// The ID of the repository to unlink from the project. (Required.)
RepositoryID ID `json:"repositoryId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
UnlinkProjectV2FromTeamInput is an autogenerated input type of UnlinkProjectV2FromTeam.
type UnlinkProjectV2FromTeamInput struct {
// The ID of the project to unlink from the team. (Required.)
ProjectID ID `json:"projectId"`
// The ID of the team to unlink from the project. (Required.)
TeamID ID `json:"teamId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
UnlinkRepositoryFromProjectInput is an autogenerated input type of UnlinkRepositoryFromProject.
type UnlinkRepositoryFromProjectInput struct {
// The ID of the Project linked to the Repository. (Required.)
ProjectID ID `json:"projectId"`
// The ID of the Repository linked to the Project. (Required.)
RepositoryID ID `json:"repositoryId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
UnlockLockableInput is an autogenerated input type of UnlockLockable.
type UnlockLockableInput struct {
// ID of the item to be unlocked. (Required.)
LockableID ID `json:"lockableId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
UnmarkDiscussionCommentAsAnswerInput is an autogenerated input type of UnmarkDiscussionCommentAsAnswer.
type UnmarkDiscussionCommentAsAnswerInput struct {
// The Node ID of the discussion comment to unmark as an answer. (Required.)
ID ID `json:"id"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
UnmarkFileAsViewedInput is an autogenerated input type of UnmarkFileAsViewed.
type UnmarkFileAsViewedInput struct {
// The Node ID of the pull request. (Required.)
PullRequestID ID `json:"pullRequestId"`
// The path of the file to mark as unviewed. (Required.)
Path String `json:"path"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
UnmarkIssueAsDuplicateInput is an autogenerated input type of UnmarkIssueAsDuplicate.
type UnmarkIssueAsDuplicateInput struct {
// ID of the issue or pull request currently marked as a duplicate. (Required.)
DuplicateID ID `json:"duplicateId"`
// ID of the issue or pull request currently considered canonical/authoritative/original. (Required.)
CanonicalID ID `json:"canonicalId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
UnmarkProjectV2AsTemplateInput is an autogenerated input type of UnmarkProjectV2AsTemplate.
type UnmarkProjectV2AsTemplateInput struct {
// The ID of the Project to unmark as a template. (Required.)
ProjectID ID `json:"projectId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
UnminimizeCommentInput is an autogenerated input type of UnminimizeComment.
type UnminimizeCommentInput struct {
// The Node ID of the subject to modify. (Required.)
SubjectID ID `json:"subjectId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
UnpinIssueInput is an autogenerated input type of UnpinIssue.
type UnpinIssueInput struct {
// The ID of the issue to be unpinned. (Required.)
IssueID ID `json:"issueId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
UnresolveReviewThreadInput is an autogenerated input type of UnresolveReviewThread.
type UnresolveReviewThreadInput struct {
// The ID of the thread to unresolve. (Required.)
ThreadID ID `json:"threadId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
UnsubscribeFromNotificationsInput is an autogenerated input type of UnsubscribeFromNotifications.
type UnsubscribeFromNotificationsInput struct {
// The NotificationThread IDs of the objects to unsubscribe from. (Required.)
IDs []ID `json:"ids"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
UpdateBranchProtectionRuleInput is an autogenerated input type of UpdateBranchProtectionRule.
type UpdateBranchProtectionRuleInput struct {
// The global relay id of the branch protection rule to be updated. (Required.)
BranchProtectionRuleID ID `json:"branchProtectionRuleId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
// The glob-like pattern used to determine matching branches. (Optional.)
Pattern *String `json:"pattern,omitempty"`
// Are approving reviews required to update matching branches. (Optional.)
RequiresApprovingReviews *Boolean `json:"requiresApprovingReviews,omitempty"`
// Number of approving reviews required to update matching branches. (Optional.)
RequiredApprovingReviewCount *Int `json:"requiredApprovingReviewCount,omitempty"`
// Are commits required to be signed. (Optional.)
RequiresCommitSignatures *Boolean `json:"requiresCommitSignatures,omitempty"`
// Are merge commits prohibited from being pushed to this branch. (Optional.)
RequiresLinearHistory *Boolean `json:"requiresLinearHistory,omitempty"`
// Is branch creation a protected operation. (Optional.)
BlocksCreations *Boolean `json:"blocksCreations,omitempty"`
// Are force pushes allowed on this branch. (Optional.)
AllowsForcePushes *Boolean `json:"allowsForcePushes,omitempty"`
// Can this branch be deleted. (Optional.)
AllowsDeletions *Boolean `json:"allowsDeletions,omitempty"`
// Can admins override branch protection. (Optional.)
IsAdminEnforced *Boolean `json:"isAdminEnforced,omitempty"`
// Are status checks required to update matching branches. (Optional.)
RequiresStatusChecks *Boolean `json:"requiresStatusChecks,omitempty"`
// Are branches required to be up to date before merging. (Optional.)
RequiresStrictStatusChecks *Boolean `json:"requiresStrictStatusChecks,omitempty"`
// Are reviews from code owners required to update matching branches. (Optional.)
RequiresCodeOwnerReviews *Boolean `json:"requiresCodeOwnerReviews,omitempty"`
// Will new commits pushed to matching branches dismiss pull request review approvals. (Optional.)
DismissesStaleReviews *Boolean `json:"dismissesStaleReviews,omitempty"`
// Is dismissal of pull request reviews restricted. (Optional.)
RestrictsReviewDismissals *Boolean `json:"restrictsReviewDismissals,omitempty"`
// A list of User, Team, or App IDs allowed to dismiss reviews on pull requests targeting matching branches. (Optional.)
ReviewDismissalActorIDs *[]ID `json:"reviewDismissalActorIds,omitempty"`
// A list of User, Team, or App IDs allowed to bypass pull requests targeting matching branches. (Optional.)
BypassPullRequestActorIDs *[]ID `json:"bypassPullRequestActorIds,omitempty"`
// A list of User, Team, or App IDs allowed to bypass force push targeting matching branches. (Optional.)
BypassForcePushActorIDs *[]ID `json:"bypassForcePushActorIds,omitempty"`
// Is pushing to matching branches restricted. (Optional.)
RestrictsPushes *Boolean `json:"restrictsPushes,omitempty"`
// A list of User, Team, or App IDs allowed to push to matching branches. (Optional.)
PushActorIDs *[]ID `json:"pushActorIds,omitempty"`
// List of required status check contexts that must pass for commits to be accepted to matching branches. (Optional.)
RequiredStatusCheckContexts *[]String `json:"requiredStatusCheckContexts,omitempty"`
// The list of required status checks. (Optional.)
RequiredStatusChecks *[]RequiredStatusCheckInput `json:"requiredStatusChecks,omitempty"`
// Are successful deployments required before merging. (Optional.)
RequiresDeployments *Boolean `json:"requiresDeployments,omitempty"`
// The list of required deployment environments. (Optional.)
RequiredDeploymentEnvironments *[]String `json:"requiredDeploymentEnvironments,omitempty"`
// Are conversations required to be resolved before merging. (Optional.)
RequiresConversationResolution *Boolean `json:"requiresConversationResolution,omitempty"`
// Whether the most recent push must be approved by someone other than the person who pushed it. (Optional.)
RequireLastPushApproval *Boolean `json:"requireLastPushApproval,omitempty"`
// Whether to set the branch as read-only. If this is true, users will not be able to push to the branch. (Optional.)
LockBranch *Boolean `json:"lockBranch,omitempty"`
// Whether users can pull changes from upstream when the branch is locked. Set to `true` to allow fork syncing. Set to `false` to prevent fork syncing. (Optional.)
LockAllowsFetchAndMerge *Boolean `json:"lockAllowsFetchAndMerge,omitempty"`
}
UpdateCheckRunInput is an autogenerated input type of UpdateCheckRun.
type UpdateCheckRunInput struct {
// The node ID of the repository. (Required.)
RepositoryID ID `json:"repositoryId"`
// The node of the check. (Required.)
CheckRunID ID `json:"checkRunId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
// The name of the check. (Optional.)
Name *String `json:"name,omitempty"`
// The URL of the integrator's site that has the full details of the check. (Optional.)
DetailsURL *URI `json:"detailsUrl,omitempty"`
// A reference for the run on the integrator's system. (Optional.)
ExternalID *String `json:"externalId,omitempty"`
// The current status. (Optional.)
Status *RequestableCheckStatusState `json:"status,omitempty"`
// The time that the check run began. (Optional.)
StartedAt *DateTime `json:"startedAt,omitempty"`
// The final conclusion of the check. (Optional.)
Conclusion *CheckConclusionState `json:"conclusion,omitempty"`
// The time that the check run finished. (Optional.)
CompletedAt *DateTime `json:"completedAt,omitempty"`
// Descriptive details about the run. (Optional.)
Output *CheckRunOutput `json:"output,omitempty"`
// Possible further actions the integrator can perform, which a user may trigger. (Optional.)
Actions *[]CheckRunAction `json:"actions,omitempty"`
}
UpdateCheckSuitePreferencesInput is an autogenerated input type of UpdateCheckSuitePreferences.
type UpdateCheckSuitePreferencesInput struct {
// The Node ID of the repository. (Required.)
RepositoryID ID `json:"repositoryId"`
// The check suite preferences to modify. (Required.)
AutoTriggerPreferences []CheckSuiteAutoTriggerPreference `json:"autoTriggerPreferences"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
UpdateDiscussionCommentInput is an autogenerated input type of UpdateDiscussionComment.
type UpdateDiscussionCommentInput struct {
// The Node ID of the discussion comment to update. (Required.)
CommentID ID `json:"commentId"`
// The new contents of the comment body. (Required.)
Body String `json:"body"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
UpdateDiscussionInput is an autogenerated input type of UpdateDiscussion.
type UpdateDiscussionInput struct {
// The Node ID of the discussion to update. (Required.)
DiscussionID ID `json:"discussionId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
// The new discussion title. (Optional.)
Title *String `json:"title,omitempty"`
// The new contents of the discussion body. (Optional.)
Body *String `json:"body,omitempty"`
// The Node ID of a discussion category within the same repository to change this discussion to. (Optional.)
CategoryID *ID `json:"categoryId,omitempty"`
}
UpdateEnterpriseAdministratorRoleInput is an autogenerated input type of UpdateEnterpriseAdministratorRole.
type UpdateEnterpriseAdministratorRoleInput struct {
// The ID of the Enterprise which the admin belongs to. (Required.)
EnterpriseID ID `json:"enterpriseId"`
// The login of a administrator whose role is being changed. (Required.)
Login String `json:"login"`
// The new role for the Enterprise administrator. (Required.)
Role EnterpriseAdministratorRole `json:"role"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
UpdateEnterpriseAllowPrivateRepositoryForkingSettingInput is an autogenerated input type of UpdateEnterpriseAllowPrivateRepositoryForkingSetting.
type UpdateEnterpriseAllowPrivateRepositoryForkingSettingInput struct {
// The ID of the enterprise on which to set the allow private repository forking setting. (Required.)
EnterpriseID ID `json:"enterpriseId"`
// The value for the allow private repository forking setting on the enterprise. (Required.)
SettingValue EnterpriseEnabledDisabledSettingValue `json:"settingValue"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
// The value for the allow private repository forking policy on the enterprise. (Optional.)
PolicyValue *EnterpriseAllowPrivateRepositoryForkingPolicyValue `json:"policyValue,omitempty"`
}
UpdateEnterpriseDefaultRepositoryPermissionSettingInput is an autogenerated input type of UpdateEnterpriseDefaultRepositoryPermissionSetting.
type UpdateEnterpriseDefaultRepositoryPermissionSettingInput struct {
// The ID of the enterprise on which to set the base repository permission setting. (Required.)
EnterpriseID ID `json:"enterpriseId"`
// The value for the base repository permission setting on the enterprise. (Required.)
SettingValue EnterpriseDefaultRepositoryPermissionSettingValue `json:"settingValue"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
UpdateEnterpriseMembersCanChangeRepositoryVisibilitySettingInput is an autogenerated input type of UpdateEnterpriseMembersCanChangeRepositoryVisibilitySetting.
type UpdateEnterpriseMembersCanChangeRepositoryVisibilitySettingInput struct {
// The ID of the enterprise on which to set the members can change repository visibility setting. (Required.)
EnterpriseID ID `json:"enterpriseId"`
// The value for the members can change repository visibility setting on the enterprise. (Required.)
SettingValue EnterpriseEnabledDisabledSettingValue `json:"settingValue"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
UpdateEnterpriseMembersCanCreateRepositoriesSettingInput is an autogenerated input type of UpdateEnterpriseMembersCanCreateRepositoriesSetting.
type UpdateEnterpriseMembersCanCreateRepositoriesSettingInput struct {
// The ID of the enterprise on which to set the members can create repositories setting. (Required.)
EnterpriseID ID `json:"enterpriseId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
// Value for the members can create repositories setting on the enterprise. This or the granular public/private/internal allowed fields (but not both) must be provided. (Optional.)
SettingValue *EnterpriseMembersCanCreateRepositoriesSettingValue `json:"settingValue,omitempty"`
// When false, allow member organizations to set their own repository creation member privileges. (Optional.)
MembersCanCreateRepositoriesPolicyEnabled *Boolean `json:"membersCanCreateRepositoriesPolicyEnabled,omitempty"`
// Allow members to create public repositories. Defaults to current value. (Optional.)
MembersCanCreatePublicRepositories *Boolean `json:"membersCanCreatePublicRepositories,omitempty"`
// Allow members to create private repositories. Defaults to current value. (Optional.)
MembersCanCreatePrivateRepositories *Boolean `json:"membersCanCreatePrivateRepositories,omitempty"`
// Allow members to create internal repositories. Defaults to current value. (Optional.)
MembersCanCreateInternalRepositories *Boolean `json:"membersCanCreateInternalRepositories,omitempty"`
}
UpdateEnterpriseMembersCanDeleteIssuesSettingInput is an autogenerated input type of UpdateEnterpriseMembersCanDeleteIssuesSetting.
type UpdateEnterpriseMembersCanDeleteIssuesSettingInput struct {
// The ID of the enterprise on which to set the members can delete issues setting. (Required.)
EnterpriseID ID `json:"enterpriseId"`
// The value for the members can delete issues setting on the enterprise. (Required.)
SettingValue EnterpriseEnabledDisabledSettingValue `json:"settingValue"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
UpdateEnterpriseMembersCanDeleteRepositoriesSettingInput is an autogenerated input type of UpdateEnterpriseMembersCanDeleteRepositoriesSetting.
type UpdateEnterpriseMembersCanDeleteRepositoriesSettingInput struct {
// The ID of the enterprise on which to set the members can delete repositories setting. (Required.)
EnterpriseID ID `json:"enterpriseId"`
// The value for the members can delete repositories setting on the enterprise. (Required.)
SettingValue EnterpriseEnabledDisabledSettingValue `json:"settingValue"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
UpdateEnterpriseMembersCanInviteCollaboratorsSettingInput is an autogenerated input type of UpdateEnterpriseMembersCanInviteCollaboratorsSetting.
type UpdateEnterpriseMembersCanInviteCollaboratorsSettingInput struct {
// The ID of the enterprise on which to set the members can invite collaborators setting. (Required.)
EnterpriseID ID `json:"enterpriseId"`
// The value for the members can invite collaborators setting on the enterprise. (Required.)
SettingValue EnterpriseEnabledDisabledSettingValue `json:"settingValue"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
UpdateEnterpriseMembersCanMakePurchasesSettingInput is an autogenerated input type of UpdateEnterpriseMembersCanMakePurchasesSetting.
type UpdateEnterpriseMembersCanMakePurchasesSettingInput struct {
// The ID of the enterprise on which to set the members can make purchases setting. (Required.)
EnterpriseID ID `json:"enterpriseId"`
// The value for the members can make purchases setting on the enterprise. (Required.)
SettingValue EnterpriseMembersCanMakePurchasesSettingValue `json:"settingValue"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
UpdateEnterpriseMembersCanUpdateProtectedBranchesSettingInput is an autogenerated input type of UpdateEnterpriseMembersCanUpdateProtectedBranchesSetting.
type UpdateEnterpriseMembersCanUpdateProtectedBranchesSettingInput struct {
// The ID of the enterprise on which to set the members can update protected branches setting. (Required.)
EnterpriseID ID `json:"enterpriseId"`
// The value for the members can update protected branches setting on the enterprise. (Required.)
SettingValue EnterpriseEnabledDisabledSettingValue `json:"settingValue"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
UpdateEnterpriseMembersCanViewDependencyInsightsSettingInput is an autogenerated input type of UpdateEnterpriseMembersCanViewDependencyInsightsSetting.
type UpdateEnterpriseMembersCanViewDependencyInsightsSettingInput struct {
// The ID of the enterprise on which to set the members can view dependency insights setting. (Required.)
EnterpriseID ID `json:"enterpriseId"`
// The value for the members can view dependency insights setting on the enterprise. (Required.)
SettingValue EnterpriseEnabledDisabledSettingValue `json:"settingValue"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
UpdateEnterpriseOrganizationProjectsSettingInput is an autogenerated input type of UpdateEnterpriseOrganizationProjectsSetting.
type UpdateEnterpriseOrganizationProjectsSettingInput struct {
// The ID of the enterprise on which to set the organization projects setting. (Required.)
EnterpriseID ID `json:"enterpriseId"`
// The value for the organization projects setting on the enterprise. (Required.)
SettingValue EnterpriseEnabledDisabledSettingValue `json:"settingValue"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
UpdateEnterpriseOwnerOrganizationRoleInput is an autogenerated input type of UpdateEnterpriseOwnerOrganizationRole.
type UpdateEnterpriseOwnerOrganizationRoleInput struct {
// The ID of the Enterprise which the owner belongs to. (Required.)
EnterpriseID ID `json:"enterpriseId"`
// The ID of the organization for membership change. (Required.)
OrganizationID ID `json:"organizationId"`
// The role to assume in the organization. (Required.)
OrganizationRole RoleInOrganization `json:"organizationRole"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
UpdateEnterpriseProfileInput is an autogenerated input type of UpdateEnterpriseProfile.
type UpdateEnterpriseProfileInput struct {
// The Enterprise ID to update. (Required.)
EnterpriseID ID `json:"enterpriseId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
// The name of the enterprise. (Optional.)
Name *String `json:"name,omitempty"`
// The description of the enterprise. (Optional.)
Description *String `json:"description,omitempty"`
// The URL of the enterprise's website. (Optional.)
WebsiteURL *String `json:"websiteUrl,omitempty"`
// The location of the enterprise. (Optional.)
Location *String `json:"location,omitempty"`
}
UpdateEnterpriseRepositoryProjectsSettingInput is an autogenerated input type of UpdateEnterpriseRepositoryProjectsSetting.
type UpdateEnterpriseRepositoryProjectsSettingInput struct {
// The ID of the enterprise on which to set the repository projects setting. (Required.)
EnterpriseID ID `json:"enterpriseId"`
// The value for the repository projects setting on the enterprise. (Required.)
SettingValue EnterpriseEnabledDisabledSettingValue `json:"settingValue"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
UpdateEnterpriseTeamDiscussionsSettingInput is an autogenerated input type of UpdateEnterpriseTeamDiscussionsSetting.
type UpdateEnterpriseTeamDiscussionsSettingInput struct {
// The ID of the enterprise on which to set the team discussions setting. (Required.)
EnterpriseID ID `json:"enterpriseId"`
// The value for the team discussions setting on the enterprise. (Required.)
SettingValue EnterpriseEnabledDisabledSettingValue `json:"settingValue"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
UpdateEnterpriseTwoFactorAuthenticationRequiredSettingInput is an autogenerated input type of UpdateEnterpriseTwoFactorAuthenticationRequiredSetting.
type UpdateEnterpriseTwoFactorAuthenticationRequiredSettingInput struct {
// The ID of the enterprise on which to set the two factor authentication required setting. (Required.)
EnterpriseID ID `json:"enterpriseId"`
// The value for the two factor authentication required setting on the enterprise. (Required.)
SettingValue EnterpriseEnabledSettingValue `json:"settingValue"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
UpdateEnvironmentInput is an autogenerated input type of UpdateEnvironment.
type UpdateEnvironmentInput struct {
// The node ID of the environment. (Required.)
EnvironmentID ID `json:"environmentId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
// The wait timer in minutes. (Optional.)
WaitTimer *Int `json:"waitTimer,omitempty"`
// The ids of users or teams that can approve deployments to this environment. (Optional.)
Reviewers *[]ID `json:"reviewers,omitempty"`
// Whether deployments to this environment can be approved by the user who created the deployment. (Optional.)
PreventSelfReview *Boolean `json:"preventSelfReview,omitempty"`
}
UpdateIpAllowListEnabledSettingInput is an autogenerated input type of UpdateIpAllowListEnabledSetting.
type UpdateIpAllowListEnabledSettingInput struct {
// The ID of the owner on which to set the IP allow list enabled setting. (Required.)
OwnerID ID `json:"ownerId"`
// The value for the IP allow list enabled setting. (Required.)
SettingValue IpAllowListEnabledSettingValue `json:"settingValue"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
UpdateIpAllowListEntryInput is an autogenerated input type of UpdateIpAllowListEntry.
type UpdateIpAllowListEntryInput struct {
// The ID of the IP allow list entry to update. (Required.)
IPAllowListEntryID ID `json:"ipAllowListEntryId"`
// An IP address or range of addresses in CIDR notation. (Required.)
AllowListValue String `json:"allowListValue"`
// Whether the IP allow list entry is active when an IP allow list is enabled. (Required.)
IsActive Boolean `json:"isActive"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
// An optional name for the IP allow list entry. (Optional.)
Name *String `json:"name,omitempty"`
}
UpdateIpAllowListForInstalledAppsEnabledSettingInput is an autogenerated input type of UpdateIpAllowListForInstalledAppsEnabledSetting.
type UpdateIpAllowListForInstalledAppsEnabledSettingInput struct {
// The ID of the owner. (Required.)
OwnerID ID `json:"ownerId"`
// The value for the IP allow list configuration for installed GitHub Apps setting. (Required.)
SettingValue IpAllowListForInstalledAppsEnabledSettingValue `json:"settingValue"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
UpdateIssueCommentInput is an autogenerated input type of UpdateIssueComment.
type UpdateIssueCommentInput struct {
// The ID of the IssueComment to modify. (Required.)
ID ID `json:"id"`
// The updated text of the comment. (Required.)
Body String `json:"body"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
UpdateIssueInput is an autogenerated input type of UpdateIssue.
type UpdateIssueInput struct {
// The ID of the Issue to modify. (Required.)
ID ID `json:"id"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
// The title for the issue. (Optional.)
Title *String `json:"title,omitempty"`
// The body for the issue description. (Optional.)
Body *String `json:"body,omitempty"`
// An array of Node IDs of users for this issue. (Optional.)
AssigneeIDs *[]ID `json:"assigneeIds,omitempty"`
// The Node ID of the milestone for this issue. (Optional.)
MilestoneID *ID `json:"milestoneId,omitempty"`
// An array of Node IDs of labels for this issue. (Optional.)
LabelIDs *[]ID `json:"labelIds,omitempty"`
// The desired issue state. (Optional.)
State *IssueState `json:"state,omitempty"`
// An array of Node IDs for projects associated with this issue. (Optional.)
ProjectIDs *[]ID `json:"projectIds,omitempty"`
}
UpdateLabelInput is an autogenerated input type of UpdateLabel.
type UpdateLabelInput struct {
// The Node ID of the label to be updated. (Required.)
ID ID `json:"id"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
// A 6 character hex code, without the leading #, identifying the updated color of the label. (Optional.)
Color *String `json:"color,omitempty"`
// A brief description of the label, such as its purpose. (Optional.)
Description *String `json:"description,omitempty"`
// The updated name of the label. (Optional.)
Name *String `json:"name,omitempty"`
}
UpdateNotificationRestrictionSettingInput is an autogenerated input type of UpdateNotificationRestrictionSetting.
type UpdateNotificationRestrictionSettingInput struct {
// The ID of the owner on which to set the restrict notifications setting. (Required.)
OwnerID ID `json:"ownerId"`
// The value for the restrict notifications setting. (Required.)
SettingValue NotificationRestrictionSettingValue `json:"settingValue"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
UpdateOrganizationAllowPrivateRepositoryForkingSettingInput is an autogenerated input type of UpdateOrganizationAllowPrivateRepositoryForkingSetting.
type UpdateOrganizationAllowPrivateRepositoryForkingSettingInput struct {
// The ID of the organization on which to set the allow private repository forking setting. (Required.)
OrganizationID ID `json:"organizationId"`
// Enable forking of private repositories in the organization?. (Required.)
ForkingEnabled Boolean `json:"forkingEnabled"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
UpdateOrganizationWebCommitSignoffSettingInput is an autogenerated input type of UpdateOrganizationWebCommitSignoffSetting.
type UpdateOrganizationWebCommitSignoffSettingInput struct {
// The ID of the organization on which to set the web commit signoff setting. (Required.)
OrganizationID ID `json:"organizationId"`
// Enable signoff on web-based commits for repositories in the organization?. (Required.)
WebCommitSignoffRequired Boolean `json:"webCommitSignoffRequired"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
UpdateParametersInput represents only allow users with bypass permission to update matching refs.
type UpdateParametersInput struct {
// Branch can pull changes from its upstream repository. (Required.)
UpdateAllowsFetchAndMerge Boolean `json:"updateAllowsFetchAndMerge"`
}
UpdatePatreonSponsorabilityInput is an autogenerated input type of UpdatePatreonSponsorability.
type UpdatePatreonSponsorabilityInput struct {
// Whether Patreon tiers should be shown on the GitHub Sponsors profile page, allowing potential sponsors to make their payment through Patreon instead of GitHub. (Required.)
EnablePatreonSponsorships Boolean `json:"enablePatreonSponsorships"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
// The username of the organization with the GitHub Sponsors profile, if any. Defaults to the GitHub Sponsors profile for the authenticated user if omitted. (Optional.)
SponsorableLogin *String `json:"sponsorableLogin,omitempty"`
}
UpdateProjectCardInput is an autogenerated input type of UpdateProjectCard.
type UpdateProjectCardInput struct {
// The ProjectCard ID to update. (Required.)
ProjectCardID ID `json:"projectCardId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
// Whether or not the ProjectCard should be archived. (Optional.)
IsArchived *Boolean `json:"isArchived,omitempty"`
// The note of ProjectCard. (Optional.)
Note *String `json:"note,omitempty"`
}
UpdateProjectColumnInput is an autogenerated input type of UpdateProjectColumn.
type UpdateProjectColumnInput struct {
// The ProjectColumn ID to update. (Required.)
ProjectColumnID ID `json:"projectColumnId"`
// The name of project column. (Required.)
Name String `json:"name"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
UpdateProjectInput is an autogenerated input type of UpdateProject.
type UpdateProjectInput struct {
// The Project ID to update. (Required.)
ProjectID ID `json:"projectId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
// The name of project. (Optional.)
Name *String `json:"name,omitempty"`
// The description of project. (Optional.)
Body *String `json:"body,omitempty"`
// Whether the project is open or closed. (Optional.)
State *ProjectState `json:"state,omitempty"`
// Whether the project is public or not. (Optional.)
Public *Boolean `json:"public,omitempty"`
}
UpdateProjectV2CollaboratorsInput is an autogenerated input type of UpdateProjectV2Collaborators.
type UpdateProjectV2CollaboratorsInput struct {
// The ID of the project to update the collaborators for. (Required.)
ProjectID ID `json:"projectId"`
// The collaborators to update. (Required.)
Collaborators []ProjectV2Collaborator `json:"collaborators"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
UpdateProjectV2DraftIssueInput is an autogenerated input type of UpdateProjectV2DraftIssue.
type UpdateProjectV2DraftIssueInput struct {
// The ID of the draft issue to update. (Required.)
DraftIssueID ID `json:"draftIssueId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
// The title of the draft issue. (Optional.)
Title *String `json:"title,omitempty"`
// The body of the draft issue. (Optional.)
Body *String `json:"body,omitempty"`
// The IDs of the assignees of the draft issue. (Optional.)
AssigneeIDs *[]ID `json:"assigneeIds,omitempty"`
}
UpdateProjectV2Input is an autogenerated input type of UpdateProjectV2.
type UpdateProjectV2Input struct {
// The ID of the Project to update. (Required.)
ProjectID ID `json:"projectId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
// Set the title of the project. (Optional.)
Title *String `json:"title,omitempty"`
// Set the short description of the project. (Optional.)
ShortDescription *String `json:"shortDescription,omitempty"`
// Set the readme description of the project. (Optional.)
Readme *String `json:"readme,omitempty"`
// Set the project to closed or open. (Optional.)
Closed *Boolean `json:"closed,omitempty"`
// Set the project to public or private. (Optional.)
Public *Boolean `json:"public,omitempty"`
}
UpdateProjectV2ItemFieldValueInput is an autogenerated input type of UpdateProjectV2ItemFieldValue.
type UpdateProjectV2ItemFieldValueInput struct {
// The ID of the Project. (Required.)
ProjectID ID `json:"projectId"`
// The ID of the item to be updated. (Required.)
ItemID ID `json:"itemId"`
// The ID of the field to be updated. (Required.)
FieldID ID `json:"fieldId"`
// The value which will be set on the field. (Required.)
Value ProjectV2FieldValue `json:"value"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
UpdateProjectV2ItemPositionInput is an autogenerated input type of UpdateProjectV2ItemPosition.
type UpdateProjectV2ItemPositionInput struct {
// The ID of the Project. (Required.)
ProjectID ID `json:"projectId"`
// The ID of the item to be moved. (Required.)
ItemID ID `json:"itemId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
// The ID of the item to position this item after. If omitted or set to null the item will be moved to top. (Optional.)
AfterID *ID `json:"afterId,omitempty"`
}
UpdateProjectV2StatusUpdateInput is an autogenerated input type of UpdateProjectV2StatusUpdate.
type UpdateProjectV2StatusUpdateInput struct {
// The ID of the status update to be updated. (Required.)
StatusUpdateID ID `json:"statusUpdateId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
// The start date of the status update. (Optional.)
StartDate *Date `json:"startDate,omitempty"`
// The target date of the status update. (Optional.)
TargetDate *Date `json:"targetDate,omitempty"`
// The status of the status update. (Optional.)
Status *ProjectV2StatusUpdateStatus `json:"status,omitempty"`
// The body of the status update. (Optional.)
Body *String `json:"body,omitempty"`
}
UpdatePullRequestBranchInput is an autogenerated input type of UpdatePullRequestBranch.
type UpdatePullRequestBranchInput struct {
// The Node ID of the pull request. (Required.)
PullRequestID ID `json:"pullRequestId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
// The head ref oid for the upstream branch. (Optional.)
ExpectedHeadOid *GitObjectID `json:"expectedHeadOid,omitempty"`
// The update branch method to use. If omitted, defaults to 'MERGE'. (Optional.)
UpdateMethod *PullRequestBranchUpdateMethod `json:"updateMethod,omitempty"`
}
UpdatePullRequestInput is an autogenerated input type of UpdatePullRequest.
type UpdatePullRequestInput struct {
// The Node ID of the pull request. (Required.)
PullRequestID ID `json:"pullRequestId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
// The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. (Optional.)
BaseRefName *String `json:"baseRefName,omitempty"`
// The title of the pull request. (Optional.)
Title *String `json:"title,omitempty"`
// The contents of the pull request. (Optional.)
Body *String `json:"body,omitempty"`
// The target state of the pull request. (Optional.)
State *PullRequestUpdateState `json:"state,omitempty"`
// Indicates whether maintainers can modify the pull request. (Optional.)
MaintainerCanModify *Boolean `json:"maintainerCanModify,omitempty"`
// An array of Node IDs of users for this pull request. (Optional.)
AssigneeIDs *[]ID `json:"assigneeIds,omitempty"`
// The Node ID of the milestone for this pull request. (Optional.)
MilestoneID *ID `json:"milestoneId,omitempty"`
// An array of Node IDs of labels for this pull request. (Optional.)
LabelIDs *[]ID `json:"labelIds,omitempty"`
// An array of Node IDs for projects associated with this pull request. (Optional.)
ProjectIDs *[]ID `json:"projectIds,omitempty"`
}
UpdatePullRequestReviewCommentInput is an autogenerated input type of UpdatePullRequestReviewComment.
type UpdatePullRequestReviewCommentInput struct {
// The Node ID of the comment to modify. (Required.)
PullRequestReviewCommentID ID `json:"pullRequestReviewCommentId"`
// The text of the comment. (Required.)
Body String `json:"body"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
UpdatePullRequestReviewInput is an autogenerated input type of UpdatePullRequestReview.
type UpdatePullRequestReviewInput struct {
// The Node ID of the pull request review to modify. (Required.)
PullRequestReviewID ID `json:"pullRequestReviewId"`
// The contents of the pull request review body. (Required.)
Body String `json:"body"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
UpdateRefInput is an autogenerated input type of UpdateRef.
type UpdateRefInput struct {
// The Node ID of the Ref to be updated. (Required.)
RefID ID `json:"refId"`
// The GitObjectID that the Ref shall be updated to target. (Required.)
Oid GitObjectID `json:"oid"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
// Permit updates of branch Refs that are not fast-forwards?. (Optional.)
Force *Boolean `json:"force,omitempty"`
}
UpdateRefsInput is an autogenerated input type of UpdateRefs.
type UpdateRefsInput struct {
// The Node ID of the repository. (Required.)
RepositoryID ID `json:"repositoryId"`
// A list of ref updates. (Required.)
RefUpdates []RefUpdate `json:"refUpdates"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
UpdateRepositoryInput is an autogenerated input type of UpdateRepository.
type UpdateRepositoryInput struct {
// The ID of the repository to update. (Required.)
RepositoryID ID `json:"repositoryId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
// The new name of the repository. (Optional.)
Name *String `json:"name,omitempty"`
// A new description for the repository. Pass an empty string to erase the existing description. (Optional.)
Description *String `json:"description,omitempty"`
// Whether this repository should be marked as a template such that anyone who can access it can create new repositories with the same files and directory structure. (Optional.)
Template *Boolean `json:"template,omitempty"`
// The URL for a web page about this repository. Pass an empty string to erase the existing URL. (Optional.)
HomepageURL *URI `json:"homepageUrl,omitempty"`
// Indicates if the repository should have the wiki feature enabled. (Optional.)
HasWikiEnabled *Boolean `json:"hasWikiEnabled,omitempty"`
// Indicates if the repository should have the issues feature enabled. (Optional.)
HasIssuesEnabled *Boolean `json:"hasIssuesEnabled,omitempty"`
// Indicates if the repository should have the project boards feature enabled. (Optional.)
HasProjectsEnabled *Boolean `json:"hasProjectsEnabled,omitempty"`
// Indicates if the repository should have the discussions feature enabled. (Optional.)
HasDiscussionsEnabled *Boolean `json:"hasDiscussionsEnabled,omitempty"`
// Indicates if the repository displays a Sponsor button for financial contributions. (Optional.)
HasSponsorshipsEnabled *Boolean `json:"hasSponsorshipsEnabled,omitempty"`
}
UpdateRepositoryRulesetInput is an autogenerated input type of UpdateRepositoryRuleset.
type UpdateRepositoryRulesetInput struct {
// The global relay id of the repository ruleset to be updated. (Required.)
RepositoryRulesetID ID `json:"repositoryRulesetId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
// The name of the ruleset. (Optional.)
Name *String `json:"name,omitempty"`
// The target of the ruleset. (Optional.)
Target *RepositoryRulesetTarget `json:"target,omitempty"`
// The list of rules for this ruleset. (Optional.)
Rules *[]RepositoryRuleInput `json:"rules,omitempty"`
// The list of conditions for this ruleset. (Optional.)
Conditions *RepositoryRuleConditionsInput `json:"conditions,omitempty"`
// The enforcement level for this ruleset. (Optional.)
Enforcement *RuleEnforcement `json:"enforcement,omitempty"`
// A list of actors that are allowed to bypass rules in this ruleset. (Optional.)
BypassActors *[]RepositoryRulesetBypassActorInput `json:"bypassActors,omitempty"`
}
UpdateRepositoryWebCommitSignoffSettingInput is an autogenerated input type of UpdateRepositoryWebCommitSignoffSetting.
type UpdateRepositoryWebCommitSignoffSettingInput struct {
// The ID of the repository to update. (Required.)
RepositoryID ID `json:"repositoryId"`
// Indicates if the repository should require signoff on web-based commits. (Required.)
WebCommitSignoffRequired Boolean `json:"webCommitSignoffRequired"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
UpdateSponsorshipPreferencesInput is an autogenerated input type of UpdateSponsorshipPreferences.
type UpdateSponsorshipPreferencesInput struct {
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
// The ID of the user or organization who is acting as the sponsor, paying for the sponsorship. Required if sponsorLogin is not given. (Optional.)
SponsorID *ID `json:"sponsorId,omitempty"`
// The username of the user or organization who is acting as the sponsor, paying for the sponsorship. Required if sponsorId is not given. (Optional.)
SponsorLogin *String `json:"sponsorLogin,omitempty"`
// The ID of the user or organization who is receiving the sponsorship. Required if sponsorableLogin is not given. (Optional.)
SponsorableID *ID `json:"sponsorableId,omitempty"`
// The username of the user or organization who is receiving the sponsorship. Required if sponsorableId is not given. (Optional.)
SponsorableLogin *String `json:"sponsorableLogin,omitempty"`
// Whether the sponsor should receive email updates from the sponsorable. (Optional.)
ReceiveEmails *Boolean `json:"receiveEmails,omitempty"`
// Specify whether others should be able to see that the sponsor is sponsoring the sponsorable. Public visibility still does not reveal which tier is used. (Optional.)
PrivacyLevel *SponsorshipPrivacy `json:"privacyLevel,omitempty"`
}
UpdateSubscriptionInput is an autogenerated input type of UpdateSubscription.
type UpdateSubscriptionInput struct {
// The Node ID of the subscribable object to modify. (Required.)
SubscribableID ID `json:"subscribableId"`
// The new state of the subscription. (Required.)
State SubscriptionState `json:"state"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
UpdateTeamDiscussionCommentInput is an autogenerated input type of UpdateTeamDiscussionComment.
type UpdateTeamDiscussionCommentInput struct {
// The ID of the comment to modify. (Required.)
ID ID `json:"id"`
// The updated text of the comment. (Required.)
Body String `json:"body"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
// The current version of the body content. (Optional.)
BodyVersion *String `json:"bodyVersion,omitempty"`
}
UpdateTeamDiscussionInput is an autogenerated input type of UpdateTeamDiscussion.
type UpdateTeamDiscussionInput struct {
// The Node ID of the discussion to modify. (Required.)
ID ID `json:"id"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
// The updated title of the discussion. (Optional.)
Title *String `json:"title,omitempty"`
// The updated text of the discussion. (Optional.)
Body *String `json:"body,omitempty"`
// The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server. (Optional.)
BodyVersion *String `json:"bodyVersion,omitempty"`
// If provided, sets the pinned state of the updated discussion. (Optional.)
Pinned *Boolean `json:"pinned,omitempty"`
}
UpdateTeamReviewAssignmentInput is an autogenerated input type of UpdateTeamReviewAssignment.
type UpdateTeamReviewAssignmentInput struct {
// The Node ID of the team to update review assignments of. (Required.)
ID ID `json:"id"`
// Turn on or off review assignment. (Required.)
Enabled Boolean `json:"enabled"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
// The algorithm to use for review assignment. (Optional.)
Algorithm *TeamReviewAssignmentAlgorithm `json:"algorithm,omitempty"`
// The number of team members to assign. (Optional.)
TeamMemberCount *Int `json:"teamMemberCount,omitempty"`
// Notify the entire team of the PR if it is delegated. (Optional.)
NotifyTeam *Boolean `json:"notifyTeam,omitempty"`
// Remove the team review request when assigning. (Optional.)
RemoveTeamRequest *Boolean `json:"removeTeamRequest,omitempty"`
// Include the members of any child teams when assigning. (Optional.)
IncludeChildTeamMembers *Boolean `json:"includeChildTeamMembers,omitempty"`
// Count any members whose review has already been requested against the required number of members assigned to review. (Optional.)
CountMembersAlreadyRequested *Boolean `json:"countMembersAlreadyRequested,omitempty"`
// An array of team member IDs to exclude. (Optional.)
ExcludedTeamMemberIDs *[]ID `json:"excludedTeamMemberIds,omitempty"`
}
UpdateTeamsRepositoryInput is an autogenerated input type of UpdateTeamsRepository.
type UpdateTeamsRepositoryInput struct {
// Repository ID being granted access to. (Required.)
RepositoryID ID `json:"repositoryId"`
// A list of teams being granted access. Limit: 10. (Required.)
TeamIDs []ID `json:"teamIds"`
// Permission that should be granted to the teams. (Required.)
Permission RepositoryPermission `json:"permission"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
UpdateTopicsInput is an autogenerated input type of UpdateTopics.
type UpdateTopicsInput struct {
// The Node ID of the repository. (Required.)
RepositoryID ID `json:"repositoryId"`
// An array of topic names. (Required.)
TopicNames []String `json:"topicNames"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
UpdateUserListInput is an autogenerated input type of UpdateUserList.
type UpdateUserListInput struct {
// The ID of the list to update. (Required.)
ListID ID `json:"listId"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
// The name of the list. (Optional.)
Name *String `json:"name,omitempty"`
// A description of the list. (Optional.)
Description *String `json:"description,omitempty"`
// Whether or not the list is private. (Optional.)
IsPrivate *Boolean `json:"isPrivate,omitempty"`
}
UpdateUserListsForItemInput is an autogenerated input type of UpdateUserListsForItem.
type UpdateUserListsForItemInput struct {
// The item to add to the list. (Required.)
ItemID ID `json:"itemId"`
// The lists to which this item should belong. (Required.)
ListIDs []ID `json:"listIds"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
// The suggested lists to create and add this item to. (Optional.)
SuggestedListIDs *[]ID `json:"suggestedListIds,omitempty"`
}
UserBlockDuration represents the possible durations that a user can be blocked for.
type UserBlockDuration string
The possible durations that a user can be blocked for.
const (
UserBlockDurationOneDay UserBlockDuration = "ONE_DAY" // The user was blocked for 1 day.
UserBlockDurationThreeDays UserBlockDuration = "THREE_DAYS" // The user was blocked for 3 days.
UserBlockDurationOneWeek UserBlockDuration = "ONE_WEEK" // The user was blocked for 7 days.
UserBlockDurationOneMonth UserBlockDuration = "ONE_MONTH" // The user was blocked for 30 days.
UserBlockDurationPermanent UserBlockDuration = "PERMANENT" // The user was blocked permanently.
)
UserStatusOrder represents ordering options for user status connections.
type UserStatusOrder struct {
// The field to order user statuses by. (Required.)
Field UserStatusOrderField `json:"field"`
// The ordering direction. (Required.)
Direction OrderDirection `json:"direction"`
}
UserStatusOrderField represents properties by which user status connections can be ordered.
type UserStatusOrderField string
Properties by which user status connections can be ordered.
const (
UserStatusOrderFieldUpdatedAt UserStatusOrderField = "UPDATED_AT" // Order user statuses by when they were updated.
)
VerifiableDomainOrder represents ordering options for verifiable domain connections.
type VerifiableDomainOrder struct {
// The field to order verifiable domains by. (Required.)
Field VerifiableDomainOrderField `json:"field"`
// The ordering direction. (Required.)
Direction OrderDirection `json:"direction"`
}
VerifiableDomainOrderField represents properties by which verifiable domain connections can be ordered.
type VerifiableDomainOrderField string
Properties by which verifiable domain connections can be ordered.
const (
VerifiableDomainOrderFieldDomain VerifiableDomainOrderField = "DOMAIN" // Order verifiable domains by the domain name.
VerifiableDomainOrderFieldCreatedAt VerifiableDomainOrderField = "CREATED_AT" // Order verifiable domains by their creation date.
)
VerifyVerifiableDomainInput is an autogenerated input type of VerifyVerifiableDomain.
type VerifyVerifiableDomainInput struct {
// The ID of the verifiable domain to verify. (Required.)
ID ID `json:"id"`
// A unique identifier for the client performing the mutation. (Optional.)
ClientMutationID *String `json:"clientMutationId,omitempty"`
}
WorkflowFileReferenceInput represents a workflow that must run for this rule to pass.
type WorkflowFileReferenceInput struct {
// The path to the workflow file. (Required.)
Path String `json:"path"`
// The ID of the repository where the workflow is defined. (Required.)
RepositoryID Int `json:"repositoryId"`
// The ref (branch or tag) of the workflow file to use. (Optional.)
Ref *String `json:"ref,omitempty"`
// The commit SHA of the workflow file to use. (Optional.)
Sha *String `json:"sha,omitempty"`
}
WorkflowRunOrder represents ways in which lists of workflow runs can be ordered upon return.
type WorkflowRunOrder struct {
// The field by which to order workflows. (Required.)
Field WorkflowRunOrderField `json:"field"`
// The direction in which to order workflow runs by the specified field. (Required.)
Direction OrderDirection `json:"direction"`
}
WorkflowRunOrderField represents properties by which workflow run connections can be ordered.
type WorkflowRunOrderField string
Properties by which workflow run connections can be ordered.
const (
WorkflowRunOrderFieldCreatedAt WorkflowRunOrderField = "CREATED_AT" // Order workflow runs by most recently created.
)
WorkflowState represents the possible states for a workflow.
type WorkflowState string
The possible states for a workflow.
const (
WorkflowStateActive WorkflowState = "ACTIVE" // The workflow is active.
WorkflowStateDeleted WorkflowState = "DELETED" // The workflow was deleted from the git repository.
WorkflowStateDisabledFork WorkflowState = "DISABLED_FORK" // The workflow was disabled by default on a fork.
WorkflowStateDisabledInactivity WorkflowState = "DISABLED_INACTIVITY" // The workflow was disabled for inactivity in the repository.
WorkflowStateDisabledManually WorkflowState = "DISABLED_MANUALLY" // The workflow was disabled manually.
)
WorkflowsParametersInput represents require all changes made to a targeted branch to pass the specified workflows before they can be merged.
type WorkflowsParametersInput struct {
// Workflows that must pass for this rule to pass. (Required.)
Workflows []WorkflowFileReferenceInput `json:"workflows"`
// Allow repositories and branches to be created if a check would otherwise prohibit it. (Optional.)
DoNotEnforceOnCreate *Boolean `json:"doNotEnforceOnCreate,omitempty"`
}
X509Certificate is a valid x509 certificate.
type X509Certificate struct{ *x509.Certificate }
func NewX509Certificate(v X509Certificate) *X509Certificate
NewX509Certificate is a helper to make a new *X509Certificate.
func (x X509Certificate) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaler interface.
func (x *X509Certificate) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaler interface.
| Name | Synopsis |
|---|---|
| .. | |
| example | |
| githubv4dev | githubv4dev is a test program currently being used for developing githubv4 package. |