Models

Every model, enum, and type alias generated from the Spec, alphabetically.

A · B · C · D · E · F · G · H · I · L · M · N · O · P · Q · R · S · T · U · V · W

A

• AccessToken — AccessToken represents an API access token.
• ActionArtifact — ActionArtifact represents an artifact of a workflow run
• ActionRun — ActionRun represents an action run
• ActionRunJob — ActionRunJob represents a job of a run
• ActionRunner — ActionRunner represents a runner
• ActionRunnerStatus — Status indicates whether this runner is offline, or active, for example.
• ActionTask — ActionTask represents a ActionTask
• ActionTaskResponse — ActionTaskResponse returns a ActionTask
• ActionVariable — ActionVariable return value of the query API
• Activity — !!! abstract "Usage Documentation"
• ActivityOpType — the type of action
• ActivityPub — ActivityPub type
• AddCollaboratorOption — AddCollaboratorOption options when adding a user as a collaborator of a repository
• AddCollaboratorOptionPermission — Enum where members are also (and must be) strings
• AddTimeOption — AddTimeOption options for adding time to an issue
• AnnotatedTag — AnnotatedTag represents an annotated tag
• AnnotatedTagObject — AnnotatedTagObject contains meta information of the tag object
• APIError — APIError is an api error with a message
• APIForbiddenError — !!! abstract "Usage Documentation"
• APIInternalServerError — !!! abstract "Usage Documentation"
• APIInvalidTopicsError — !!! abstract "Usage Documentation"
• APINotFound — !!! abstract "Usage Documentation"
• APIRepoArchivedError — !!! abstract "Usage Documentation"
• APIUnauthorizedError — !!! abstract "Usage Documentation"
• APIValidationError — !!! abstract "Usage Documentation"
• APRemoteFollowOption — !!! abstract "Usage Documentation"
• Attachment — Attachment a generic attachment
• AttachmentType — Enum where members are also (and must be) strings

B

• BlockedUser — BlockedUser represents a blocked user.
• Branch — Branch represents a repository branch
• BranchProtection — BranchProtection represents a branch protection for a repository

C

• ChangedFile — ChangedFile store information about files affected by the pull request
• ChangeFileOperation — ChangeFileOperation for creating, updating or deleting a file
• ChangeFileOperationOperation — indicates what to do with the file
• ChangeFilesOptions — ChangeFilesOptions options for creating, updating or deleting multiple files Note: author and
• CombinedStatus — CombinedStatus holds the combined state of several statuses for a single commit
• Comment — Comment represents a comment on a commit or issue
• Commit — Commit contains information generated from a Git commit.
• CommitAffectedFiles — CommitAffectedFiles store information about files affected by the commit
• CommitDateOptions — CommitDateOptions store dates for GIT_AUTHOR_DATE and GIT_COMMITTER_DATE
• CommitMeta — CommitMeta contains meta information of a commit in terms of API.
• CommitStats — CommitStats is statistics for a RepoCommit
• CommitStatus — CommitStatus holds a single status of a single Commit
• CommitStatusState — Alias for str.
• CommitUser — CommitUser contains information of a user in the context of a commit.
• Compare — Compare represents a comparison between two commits.
• ContentsResponse — ContentsResponse contains information about a repo's entry's (dir, file, symlink, submodule) metadata and
• CreateAccessTokenOption — CreateAccessTokenOption options when create access token
• CreateBranchProtectionOption — CreateBranchProtectionOption options for creating a branch protection
• CreateBranchRepoOption — CreateBranchRepoOption options when creating a branch in a repository
• CreateEmailOption — CreateEmailOption options when creating email addresses
• CreateFileOptions — CreateFileOptions options for creating files Note: author and committer are optional (if only one is
• CreateForkOption — CreateForkOption options for creating a fork
• CreateGPGKeyOption — CreateGPGKeyOption options create user GPG key
• CreateHookOption — CreateHookOption options when create a hook
• CreateHookOptionConfig — CreateHookOptionConfig has all config options in it required are "content_type" and "url" Required
• CreateHookOptionType — Enum where members are also (and must be) strings
• CreateIssueCommentOption — CreateIssueCommentOption options for creating a comment on an issue
• CreateIssueOption — CreateIssueOption options to create one issue
• CreateKeyOption — CreateKeyOption options when creating a key
• CreateLabelOption — CreateLabelOption options for creating a label
• CreateMilestoneOption — CreateMilestoneOption options for creating a milestone
• CreateMilestoneOptionState — Enum where members are also (and must be) strings
• CreateOAuth2ApplicationOptions — CreateOAuth2ApplicationOptions holds options to create an oauth2 application
• CreateOrgOption — CreateOrgOption options for creating an organization
• CreateOrgOptionVisibility — possible values are public (default), limited or private
• CreateOrUpdateSecretOption — CreateOrUpdateSecretOption defines the properties of the secret to create or update.
• CreatePullRequestOption — CreatePullRequestOption options when creating a pull request
• CreatePullReviewComment — CreatePullReviewComment represent a review comment for creation api
• CreatePullReviewCommentOptions — CreatePullReviewComment represent a review comment for creation api
• CreatePullReviewOptions — CreatePullReviewOptions are options to create a pull review
• CreatePushMirrorOption — CreatePushMirrorOption represents need information to create a push mirror of a repository.
• CreateQuotaGroupOptions — CreateQutaGroupOptions represents the options for creating a quota group
• CreateQuotaRuleOptions — CreateQuotaRuleOptions represents the options for creating a quota rule
• CreateReleaseOption — CreateReleaseOption options when creating a release
• CreateRepoOption — CreateRepoOption options when creating repository
• CreateRepoOptionObjectFormatName — ObjectFormatName of the underlying git repository
• CreateRepoOptionTrustModel — TrustModel of the repository
• CreateStatusOption — CreateStatusOption holds the information needed to create a new CommitStatus for a Commit
• CreateTagOption — CreateTagOption options when creating a tag
• CreateTagProtectionOption — CreateTagProtectionOption options for creating a tag protection
• CreateTeamOption — CreateTeamOption options for creating a team
• CreateTeamOptionPermission — Enum where members are also (and must be) strings
• CreateUserOption — CreateUserOption create user options
• CreateVariableOption — CreateVariableOption defines the properties of the variable to create.
• CreateWikiPageOptions — CreateWikiPageOptions form for creating wiki
• Cron — Cron represents a Cron task

D

• DeleteEmailOption — DeleteEmailOption options when deleting email addresses
• DeleteFileOptions — DeleteFileOptions options for deleting files (used for other File structs below) Note: author and
• DeleteLabelsOption — DeleteLabelOption options for deleting a label
• DeployKey — DeployKey a deploy key
• DismissPullReviewOptions — DismissPullReviewOptions are options to dismiss a pull review
• DispatchWorkflowOption — DispatchWorkflowOption options when dispatching a workflow
• DispatchWorkflowRun — DispatchWorkflowRun represents a workflow run
• Duration — Alias for int.

E

• EditAttachmentOptions — EditAttachmentOptions options for editing attachments
• EditBranchProtectionOption — EditBranchProtectionOption options for editing a branch protection
• EditDeadlineOption — EditDeadlineOption options for creating a deadline
• EditGitHookOption — EditGitHookOption options when modifying one Git hook
• EditHookOption — EditHookOption options when modify one hook
• EditIssueCommentOption — EditIssueCommentOption options for editing a comment
• EditIssueOption — EditIssueOption options for editing an issue
• EditLabelOption — EditLabelOption options for editing a label
• EditMilestoneOption — EditMilestoneOption options for editing a milestone
• EditOrgOption — EditOrgOption options for editing an organization
• EditOrgOptionVisibility — possible values are public, limited or private
• EditPullRequestOption — EditPullRequestOption options when modify pull request
• EditQuotaRuleOptions — EditQuotaRuleOptions represents the options for editing a quota rule
• EditReactionOption — EditReactionOption contain the reaction type
• EditReleaseOption — EditReleaseOption options when editing a release
• EditRepoOption — EditRepoOption options when editing a repository's properties
• EditTagProtectionOption — EditTagProtectionOption options for editing a tag protection
• EditTeamOption — EditTeamOption options for editing a team
• EditTeamOptionPermission — Enum where members are also (and must be) strings
• EditUserOption — EditUserOption edit user options
• Email — Email an email address belonging to a user
• ExternalTracker — ExternalTracker represents settings for external tracker
• ExternalWiki — ExternalWiki represents setting for external wiki

F

• FileCommitResponse — FileCommitResponse contains information generated from a Git commit for a repo's file.
• FileDeleteResponse — FileDeleteResponse contains information about a repo's file that was deleted
• FileLinksResponse — FileLinksResponse contains the links for a repo's file
• FileResponse — FileResponse contains information about a repo's file
• FilesResponse — FilesResponse contains information about multiple files from a repo
• ForgeLike — ForgeLike activity data type
• ForgeOutbox — ActivityStream OrderedCollection of activities

G

• GeneralAPISettings — GeneralAPISettings contains global api settings exposed by it
• GeneralAttachmentSettings — GeneralAttachmentSettings contains global Attachment settings exposed by API
• GeneralRepoSettings — GeneralRepoSettings contains global repository settings exposed by API
• GeneralUISettings — GeneralUISettings contains global ui settings exposed by API
• GenerateRepoOption — GenerateRepoOption options when creating repository using a template
• GitBlob — GitBlob represents a git blob
• GitEntry — GitEntry represents a git tree
• GitHook — GitHook represents a Git repository hook
• GitignoreTemplateInfo — GitignoreTemplateInfo name and text of a gitignore template
• GitObject — GitObject represents a Git object.
• GitTreeResponse — GitTreeResponse returns a git tree
• GPGKey — GPGKey a user GPG key to sign commit and tag in repository
• GPGKeyEmail — GPGKeyEmail an email attached to a GPGKey

H

• Hook — Hook a hook is a web hook when one repository changed

I

• Identity — Identity for a person's identity like an author or committer
• InternalTracker — InternalTracker represents settings for internal tracker
• Issue — Issue represents an issue in a repository
• IssueConfig — !!! abstract "Usage Documentation"
• IssueConfigContactLink — !!! abstract "Usage Documentation"
• IssueConfigValidation — !!! abstract "Usage Documentation"
• IssueDeadline — IssueDeadline represents an issue deadline
• IssueFormField — IssueFormField represents a form field
• IssueFormFieldType — Alias for str.
• IssueFormFieldVisible — Alias for str.
• IssueLabelsOption — IssueLabelsOption a collection of labels
• IssueMeta — IssueMeta basic issue information
• IssueTemplate — IssueTemplate represents an issue template for a repository
• IssueTemplateLabels — Type alias for list[str].

L

• Label — Label a label to an issue or a pr
• LabelTemplate — LabelTemplate info of a Label template
• LicensesTemplateListEntry — LicensesListEntry is used for the API
• LicenseTemplateInfo — LicensesInfo contains information about a License
• ListActionRunResponse — ListActionRunResponse return a list of ActionRun

M

• MarkdownOption — MarkdownOption markdown options
• MarkupOption — MarkupOption markup options
• MergePullRequestOption — MergePullRequestForm form for merging Pull Request
• MergePullRequestOptionDo — Enum where members are also (and must be) strings
• MigrateRepoOptions — MigrateRepoOptions options for migrating repository's this is used to interact with api v1
• MigrateRepoOptionsService — Enum where members are also (and must be) strings
• Milestone — Milestone milestone is a collection of issues on one repository

N

• NewIssuePinsAllowed — NewIssuePinsAllowed represents an API response that says if new Issue Pins are allowed
• NodeInfo — NodeInfo contains standardized way of exposing metadata about a server running one of the distributed
• NodeInfoServices — NodeInfoServices contains the third party sites this server can connect to via their application API
• NodeInfoSoftware — NodeInfoSoftware contains Metadata about server software in use
• NodeInfoUsage — NodeInfoUsage contains usage statistics for this server
• NodeInfoUsageUsers — NodeInfoUsageUsers contains statistics about the users of this server
• Note — Note contains information related to a git note
• NoteOptions — !!! abstract "Usage Documentation"
• NotificationCount — NotificationCount number of unread notifications
• NotificationSubject — NotificationSubject contains the notification subject (Issue/Pull/Commit)
• NotificationThread — NotificationThread expose Notification on API
• NotifySubjectType — Alias for str.

O

• OAuth2Application — OAuth2Application represents an OAuth2 application.
• Organization — Organization represents an organization
• OrganizationPermissions — OrganizationPermissions list different users permissions on an organization

P

• Package — Package represents a package
• PackageFile — PackageFile represents a package file
• PayloadCommit — PayloadCommit represents a commit
• PayloadCommitVerification — PayloadCommitVerification represents the GPG verification of a commit
• PayloadUser — PayloadUser represents the author or committer of a commit
• Permission — Permission represents a set of permissions
• PRBranchInfo — PRBranchInfo information about a branch
• PublicKey — PublicKey publickey is a user key to push code to repository
• PullRequest — PullRequest represents a pull request
• PullRequestMeta — PullRequestMeta PR info if an issue is a PR
• PullReview — PullReview represents a pull request review
• PullReviewComment — PullReviewComment represents a comment on a pull request review
• PullReviewRequestOptions — PullReviewRequestOptions are options to add or remove pull review requests
• PushMirror — PushMirror represents information of a push mirror

Q

• QuotaGroup — QuotaGroup represents a quota group
• QuotaGroupList — Type alias for list[pyfj._generated.models.quota_group.QuotaGroup].
• QuotaInfo — QuotaInfo represents information about a user's quota
• QuotaRuleInfo — QuotaRuleInfo contains information about a quota rule
• QuotaUsed — QuotaUsed represents the quota usage of a user
• QuotaUsedArtifact — QuotaUsedArtifact represents an artifact counting towards a user's quota
• QuotaUsedArtifactList — Type alias for list[pyfj._generated.models.quota_used_artifact.QuotaUsedArtifact].
• QuotaUsedAttachment — QuotaUsedAttachment represents an attachment counting towards a user's quota
• QuotaUsedAttachmentContainedIn — Context for the attachment: URLs to the containing object
• QuotaUsedAttachmentList — Type alias for list[pyfj._generated.models.quota_used_attachment.QuotaUsedAttachment].
• QuotaUsedPackage — QuotaUsedPackage represents a package counting towards a user's quota
• QuotaUsedPackageList — Type alias for list[pyfj._generated.models.quota_used_package.QuotaUsedPackage].
• QuotaUsedSize — QuotaUsedSize represents the size-based quota usage of a user
• QuotaUsedSizeAssets — QuotaUsedSizeAssets represents the size-based asset usage of a user
• QuotaUsedSizeAssetsAttachments — QuotaUsedSizeAssetsAttachments represents the size-based attachment quota usage of a user
• QuotaUsedSizeAssetsPackages — QuotaUsedSizeAssetsPackages represents the size-based package quota usage of a user
• QuotaUsedSizeGit — QuotaUsedSizeGit represents the size-based git (lfs) quota usage of a user
• QuotaUsedSizeRepos — QuotaUsedSizeRepos represents the size-based repository quota usage of a user

R

• Reaction — Reaction contain one reaction
• Reference — Reference represents a Git reference.
• RegisterRunnerOptions — RegisterRunnerOptions declares the accepted options for registering runners.
• RegisterRunnerResponse — RegisterRunnerResponse contains the details of the just registered runner.
• RegistrationToken — RegistrationToken is a string used to register a runner with a server
• Release — Release represents a repository release
• RenameOrgOption — RenameOrgOption options when renaming an organization
• RenameUserOption — RenameUserOption options when renaming a user
• ReplaceFlagsOption — ReplaceFlagsOption options when replacing the flags of a repository
• RepoCollaboratorPermission — RepoCollaboratorPermission to get repository permission for a collaborator
• RepoCommit — RepoCommit contains information of a commit in the context of a repository.
• Repository — Repository represents a repository
• RepositoryMeta — RepositoryMeta basic repository information
• RepositoryObjectFormatName — ObjectFormatName of the underlying git repository
• RepoTargetOption — !!! abstract "Usage Documentation"
• RepoTopicOptions — RepoTopicOptions a collection of repo topic names
• RepoTransfer — RepoTransfer represents a pending repo transfer
• ReviewStateType — Alias for str.

S

• SearchResults — SearchResults results of a successful search
• Secret — Secret represents a secret
• ServerVersion — ServerVersion wraps the version of the server
• SetUserQuotaGroupsOptions — SetUserQuotaGroupsOptions represents the quota groups of a user
• StateType — Alias for str.
• StopWatch — StopWatch represent a running stopwatch
• SubmitPullReviewOptions — SubmitPullReviewOptions are options to submit a pending pull review
• SyncForkInfo — SyncForkInfo information about syncing a fork

T

• Tag — Tag represents a repository tag
• TagArchiveDownloadCount — TagArchiveDownloadCount counts how many times a archive was downloaded
• TagProtection — TagProtection represents a tag protection
• Team — Team represents a team in an organization
• TeamPermission — Enum where members are also (and must be) strings
• TeamSearchResults — TeamSearchResults
• TimelineComment — TimelineComment represents a timeline comment (comment of any type) on a commit or issue
• TimeStamp — Alias for int.
• TopicName — TopicName a list of repo topic names
• TopicResponse — TopicResponse for returning topics
• TopicSearchResults — TopicSearchResults
• TrackedTime — TrackedTime worked time for an issue / pr
• TransferRepoOption — TransferRepoOption options when transfer a repository's ownership

U

• UpdateBranchRepoOption — UpdateBranchRepoOption options when updating a branch in a repository
• UpdateFileOptions — UpdateFileOptions options for updating files Note: author and committer are optional (if only one is
• UpdateRepoAvatarOption — UpdateRepoAvatarUserOption options when updating the repo avatar
• UpdateUserAvatarOption — UpdateUserAvatarUserOption options when updating the user avatar
• UpdateVariableOption — UpdateVariableOption defines the properties of the variable to update.
• User — User represents a user
• UserHeatmapData — UserHeatmapData represents the data needed to create a heatmap
• UserSearchResults — UserSearchResults
• UserSettings — UserSettings represents user settings
• UserSettingsOptions — UserSettingsOptions represents options to change user settings

V

• VerifyGPGKeyOption — VerifyGPGKeyOption options verifies user GPG key

W

• WatchInfo — WatchInfo represents an API watch status of one repository
• WikiCommit — WikiCommit page commit/revision
• WikiCommitList — WikiCommitList commit/revision list
• WikiPage — WikiPage a wiki page
• WikiPageMetaData — WikiPageMetaData wiki page meta information