GitHubKit 0.11.6__py3-none-any.whl → 0.11.8__py3-none-any.whl

githubkit/versions/v2022_11_28/models/group_0297.py

@@ -9,7 +9,8 @@ See https://github.com/github/rest-api-description for more information.
 
 from __future__ import annotations
 
-from typing import Union
+from datetime import date, datetime
+from typing import List, Union, Literal
 
 from pydantic import Field
 
@@ -18,94 +19,82 @@ from githubkit.typing import Missing
 from githubkit.compat import GitHubModel, model_rebuild
 
 
-class PagesHealthCheck(GitHubModel):
-    """Pages Health Check Status
+class Page(GitHubModel):
+    """GitHub Pages
 
-    Pages Health Check Status
+    The configuration for GitHub Pages for a repository.
     """
 
-    domain: Missing[PagesHealthCheckPropDomain] = Field(default=UNSET)
-    alt_domain: Missing[Union[PagesHealthCheckPropAltDomain, None]] = Field(
-        default=UNSET
+    url: str = Field(description="The API address for accessing this Page resource.")
+    status: Union[None, Literal["built", "building", "errored"]] = Field(
+        description="The status of the most recent build of the Page."
+    )
+    cname: Union[str, None] = Field(description="The Pages site's custom domain")
+    protected_domain_state: Missing[
+        Union[None, Literal["pending", "verified", "unverified"]]
+    ] = Field(default=UNSET, description="The state if the domain is verified")
+    pending_domain_unverified_at: Missing[Union[datetime, None]] = Field(
+        default=UNSET,
+        description="The timestamp when a pending domain becomes unverified.",
+    )
+    custom_404: bool = Field(
+        default=False, description="Whether the Page has a custom 404 page."
+    )
+    html_url: Missing[str] = Field(
+        default=UNSET, description="The web address the Page can be accessed from."
+    )
+    build_type: Missing[Union[None, Literal["legacy", "workflow"]]] = Field(
+        default=UNSET, description="The process in which the Page will be built."
+    )
+    source: Missing[PagesSourceHash] = Field(default=UNSET, title="Pages Source Hash")
+    public: bool = Field(
+        description="Whether the GitHub Pages site is publicly visible. If set to `true`, the site is accessible to anyone on the internet. If set to `false`, the site will only be accessible to users who have at least `read` access to the repository that published the site."
+    )
+    https_certificate: Missing[PagesHttpsCertificate] = Field(
+        default=UNSET, title="Pages Https Certificate"
+    )
+    https_enforced: Missing[bool] = Field(
+        default=UNSET, description="Whether https is enabled on the domain"
     )
 
 
-class PagesHealthCheckPropDomain(GitHubModel):
-    """PagesHealthCheckPropDomain"""
-
-    host: Missing[str] = Field(default=UNSET)
-    uri: Missing[str] = Field(default=UNSET)
-    nameservers: Missing[str] = Field(default=UNSET)
-    dns_resolves: Missing[bool] = Field(default=UNSET)
-    is_proxied: Missing[Union[bool, None]] = Field(default=UNSET)
-    is_cloudflare_ip: Missing[Union[bool, None]] = Field(default=UNSET)
-    is_fastly_ip: Missing[Union[bool, None]] = Field(default=UNSET)
-    is_old_ip_address: Missing[Union[bool, None]] = Field(default=UNSET)
-    is_a_record: Missing[Union[bool, None]] = Field(default=UNSET)
-    has_cname_record: Missing[Union[bool, None]] = Field(default=UNSET)
-    has_mx_records_present: Missing[Union[bool, None]] = Field(default=UNSET)
-    is_valid_domain: Missing[bool] = Field(default=UNSET)
-    is_apex_domain: Missing[bool] = Field(default=UNSET)
-    should_be_a_record: Missing[Union[bool, None]] = Field(default=UNSET)
-    is_cname_to_github_user_domain: Missing[Union[bool, None]] = Field(default=UNSET)
-    is_cname_to_pages_dot_github_dot_com: Missing[Union[bool, None]] = Field(
-        default=UNSET
-    )
-    is_cname_to_fastly: Missing[Union[bool, None]] = Field(default=UNSET)
-    is_pointed_to_github_pages_ip: Missing[Union[bool, None]] = Field(default=UNSET)
-    is_non_github_pages_ip_present: Missing[Union[bool, None]] = Field(default=UNSET)
-    is_pages_domain: Missing[bool] = Field(default=UNSET)
-    is_served_by_pages: Missing[Union[bool, None]] = Field(default=UNSET)
-    is_valid: Missing[bool] = Field(default=UNSET)
-    reason: Missing[Union[str, None]] = Field(default=UNSET)
-    responds_to_https: Missing[bool] = Field(default=UNSET)
-    enforces_https: Missing[bool] = Field(default=UNSET)
-    https_error: Missing[Union[str, None]] = Field(default=UNSET)
-    is_https_eligible: Missing[Union[bool, None]] = Field(default=UNSET)
-    caa_error: Missing[Union[str, None]] = Field(default=UNSET)
-
-
-class PagesHealthCheckPropAltDomain(GitHubModel):
-    """PagesHealthCheckPropAltDomain"""
-
-    host: Missing[str] = Field(default=UNSET)
-    uri: Missing[str] = Field(default=UNSET)
-    nameservers: Missing[str] = Field(default=UNSET)
-    dns_resolves: Missing[bool] = Field(default=UNSET)
-    is_proxied: Missing[Union[bool, None]] = Field(default=UNSET)
-    is_cloudflare_ip: Missing[Union[bool, None]] = Field(default=UNSET)
-    is_fastly_ip: Missing[Union[bool, None]] = Field(default=UNSET)
-    is_old_ip_address: Missing[Union[bool, None]] = Field(default=UNSET)
-    is_a_record: Missing[Union[bool, None]] = Field(default=UNSET)
-    has_cname_record: Missing[Union[bool, None]] = Field(default=UNSET)
-    has_mx_records_present: Missing[Union[bool, None]] = Field(default=UNSET)
-    is_valid_domain: Missing[bool] = Field(default=UNSET)
-    is_apex_domain: Missing[bool] = Field(default=UNSET)
-    should_be_a_record: Missing[Union[bool, None]] = Field(default=UNSET)
-    is_cname_to_github_user_domain: Missing[Union[bool, None]] = Field(default=UNSET)
-    is_cname_to_pages_dot_github_dot_com: Missing[Union[bool, None]] = Field(
-        default=UNSET
+class PagesSourceHash(GitHubModel):
+    """Pages Source Hash"""
+
+    branch: str = Field()
+    path: str = Field()
+
+
+class PagesHttpsCertificate(GitHubModel):
+    """Pages Https Certificate"""
+
+    state: Literal[
+        "new",
+        "authorization_created",
+        "authorization_pending",
+        "authorized",
+        "authorization_revoked",
+        "issued",
+        "uploaded",
+        "approved",
+        "errored",
+        "bad_authz",
+        "destroy_pending",
+        "dns_changed",
+    ] = Field()
+    description: str = Field()
+    domains: List[str] = Field(
+        description="Array of the domain set and its alternate name (if it is configured)"
     )
-    is_cname_to_fastly: Missing[Union[bool, None]] = Field(default=UNSET)
-    is_pointed_to_github_pages_ip: Missing[Union[bool, None]] = Field(default=UNSET)
-    is_non_github_pages_ip_present: Missing[Union[bool, None]] = Field(default=UNSET)
-    is_pages_domain: Missing[bool] = Field(default=UNSET)
-    is_served_by_pages: Missing[Union[bool, None]] = Field(default=UNSET)
-    is_valid: Missing[bool] = Field(default=UNSET)
-    reason: Missing[Union[str, None]] = Field(default=UNSET)
-    responds_to_https: Missing[bool] = Field(default=UNSET)
-    enforces_https: Missing[bool] = Field(default=UNSET)
-    https_error: Missing[Union[str, None]] = Field(default=UNSET)
-    is_https_eligible: Missing[Union[bool, None]] = Field(default=UNSET)
-    caa_error: Missing[Union[str, None]] = Field(default=UNSET)
-
-
-model_rebuild(PagesHealthCheck)
-model_rebuild(PagesHealthCheckPropDomain)
-model_rebuild(PagesHealthCheckPropAltDomain)
+    expires_at: Missing[date] = Field(default=UNSET)
+
+
+model_rebuild(Page)
+model_rebuild(PagesSourceHash)
+model_rebuild(PagesHttpsCertificate)
 
 __all__ = (
-    "PagesHealthCheck",
-    "PagesHealthCheckPropDomain",
-    "PagesHealthCheckPropAltDomain",
+    "Page",
+    "PagesSourceHash",
+    "PagesHttpsCertificate",
 )

githubkit/versions/v2022_11_28/models/group_0298.py

@@ -9,106 +9,42 @@ See https://github.com/github/rest-api-description for more information.
 
 from __future__ import annotations
 
+from typing import Union
 from datetime import datetime
-from typing import List, Union, Literal
 
 from pydantic import Field
 
-from githubkit.utils import UNSET
-from githubkit.typing import Missing
 from githubkit.compat import GitHubModel, model_rebuild
 
-from .group_0033 import Milestone
-from .group_0219 import AutoMerge
 from .group_0001 import SimpleUser
-from .group_0075 import TeamSimple
-from .group_0300 import PullRequestPropBase
-from .group_0302 import PullRequestPropLinks
-from .group_0299 import PullRequestPropHead, PullRequestPropLabelsItems
 
 
-class PullRequest(GitHubModel):
-    """Pull Request
+class PageBuild(GitHubModel):
+    """Page Build
 
-    Pull requests let you tell others about changes you've pushed to a repository on
-    GitHub. Once a pull request is sent, interested parties can review the set of
-    changes, discuss potential modifications, and even push follow-up commits if
-    necessary.
+    Page Build
     """
 
     url: str = Field()
-    id: int = Field()
-    node_id: str = Field()
-    html_url: str = Field()
-    diff_url: str = Field()
-    patch_url: str = Field()
-    issue_url: str = Field()
-    commits_url: str = Field()
-    review_comments_url: str = Field()
-    review_comment_url: str = Field()
-    comments_url: str = Field()
-    statuses_url: str = Field()
-    number: int = Field(
-        description="Number uniquely identifying the pull request within its repository."
-    )
-    state: Literal["open", "closed"] = Field(
-        description="State of this Pull Request. Either `open` or `closed`."
-    )
-    locked: bool = Field()
-    title: str = Field(description="The title of the pull request.")
-    user: SimpleUser = Field(title="Simple User", description="A GitHub user.")
-    body: Union[str, None] = Field()
-    labels: List[PullRequestPropLabelsItems] = Field()
-    milestone: Union[None, Milestone] = Field()
-    active_lock_reason: Missing[Union[str, None]] = Field(default=UNSET)
+    status: str = Field()
+    error: PageBuildPropError = Field()
+    pusher: Union[None, SimpleUser] = Field()
+    commit: str = Field()
+    duration: int = Field()
     created_at: datetime = Field()
     updated_at: datetime = Field()
-    closed_at: Union[datetime, None] = Field()
-    merged_at: Union[datetime, None] = Field()
-    merge_commit_sha: Union[str, None] = Field()
-    assignee: Union[None, SimpleUser] = Field()
-    assignees: Missing[Union[List[SimpleUser], None]] = Field(default=UNSET)
-    requested_reviewers: Missing[Union[List[SimpleUser], None]] = Field(default=UNSET)
-    requested_teams: Missing[Union[List[TeamSimple], None]] = Field(default=UNSET)
-    head: PullRequestPropHead = Field()
-    base: PullRequestPropBase = Field()
-    links: PullRequestPropLinks = Field(alias="_links")
-    author_association: Literal[
-        "COLLABORATOR",
-        "CONTRIBUTOR",
-        "FIRST_TIMER",
-        "FIRST_TIME_CONTRIBUTOR",
-        "MANNEQUIN",
-        "MEMBER",
-        "NONE",
-        "OWNER",
-    ] = Field(
-        title="author_association",
-        description="How the author is associated with the repository.",
-    )
-    auto_merge: Union[AutoMerge, None] = Field(
-        title="Auto merge", description="The status of auto merging a pull request."
-    )
-    draft: Missing[bool] = Field(
-        default=UNSET,
-        description="Indicates whether or not the pull request is a draft.",
-    )
-    merged: bool = Field()
-    mergeable: Union[bool, None] = Field()
-    rebaseable: Missing[Union[bool, None]] = Field(default=UNSET)
-    mergeable_state: str = Field()
-    merged_by: Union[None, SimpleUser] = Field()
-    comments: int = Field()
-    review_comments: int = Field()
-    maintainer_can_modify: bool = Field(
-        description="Indicates whether maintainers can modify the pull request."
-    )
-    commits: int = Field()
-    additions: int = Field()
-    deletions: int = Field()
-    changed_files: int = Field()
-
-
-model_rebuild(PullRequest)
-
-__all__ = ("PullRequest",)
+
+
+class PageBuildPropError(GitHubModel):
+    """PageBuildPropError"""
+
+    message: Union[str, None] = Field()
+
+
+model_rebuild(PageBuild)
+model_rebuild(PageBuildPropError)
+
+__all__ = (
+    "PageBuild",
+    "PageBuildPropError",
+)

githubkit/versions/v2022_11_28/models/group_0299.py

@@ -9,215 +9,21 @@ See https://github.com/github/rest-api-description for more information.
 
 from __future__ import annotations
 
-from datetime import datetime
-from typing import List, Union
-
 from pydantic import Field
 
-from githubkit.utils import UNSET
-from githubkit.typing import Missing
 from githubkit.compat import GitHubModel, model_rebuild
 
 
-class PullRequestPropLabelsItems(GitHubModel):
-    """PullRequestPropLabelsItems"""
-
-    id: int = Field()
-    node_id: str = Field()
-    url: str = Field()
-    name: str = Field()
-    description: Union[str, None] = Field()
-    color: str = Field()
-    default: bool = Field()
-
-
-class PullRequestPropHead(GitHubModel):
-    """PullRequestPropHead"""
-
-    label: Union[str, None] = Field()
-    ref: str = Field()
-    repo: Union[PullRequestPropHeadPropRepo, None] = Field()
-    sha: str = Field()
-    user: Union[PullRequestPropHeadPropUser, None] = Field()
-
-
-class PullRequestPropHeadPropRepo(GitHubModel):
-    """PullRequestPropHeadPropRepo"""
-
-    archive_url: str = Field()
-    assignees_url: str = Field()
-    blobs_url: str = Field()
-    branches_url: str = Field()
-    collaborators_url: str = Field()
-    comments_url: str = Field()
-    commits_url: str = Field()
-    compare_url: str = Field()
-    contents_url: str = Field()
-    contributors_url: str = Field()
-    deployments_url: str = Field()
-    description: Union[str, None] = Field()
-    downloads_url: str = Field()
-    events_url: str = Field()
-    fork: bool = Field()
-    forks_url: str = Field()
-    full_name: str = Field()
-    git_commits_url: str = Field()
-    git_refs_url: str = Field()
-    git_tags_url: str = Field()
-    hooks_url: str = Field()
-    html_url: str = Field()
-    id: int = Field()
-    node_id: str = Field()
-    issue_comment_url: str = Field()
-    issue_events_url: str = Field()
-    issues_url: str = Field()
-    keys_url: str = Field()
-    labels_url: str = Field()
-    languages_url: str = Field()
-    merges_url: str = Field()
-    milestones_url: str = Field()
-    name: str = Field()
-    notifications_url: str = Field()
-    owner: PullRequestPropHeadPropRepoPropOwner = Field()
-    private: bool = Field()
-    pulls_url: str = Field()
-    releases_url: str = Field()
-    stargazers_url: str = Field()
-    statuses_url: str = Field()
-    subscribers_url: str = Field()
-    subscription_url: str = Field()
-    tags_url: str = Field()
-    teams_url: str = Field()
-    trees_url: str = Field()
-    url: str = Field()
-    clone_url: str = Field()
-    default_branch: str = Field()
-    forks: int = Field()
-    forks_count: int = Field()
-    git_url: str = Field()
-    has_downloads: bool = Field()
-    has_issues: bool = Field()
-    has_projects: bool = Field()
-    has_wiki: bool = Field()
-    has_pages: bool = Field()
-    has_discussions: bool = Field()
-    homepage: Union[str, None] = Field()
-    language: Union[str, None] = Field()
-    master_branch: Missing[str] = Field(default=UNSET)
-    archived: bool = Field()
-    disabled: bool = Field()
-    visibility: Missing[str] = Field(
-        default=UNSET,
-        description="The repository visibility: public, private, or internal.",
-    )
-    mirror_url: Union[str, None] = Field()
-    open_issues: int = Field()
-    open_issues_count: int = Field()
-    permissions: Missing[PullRequestPropHeadPropRepoPropPermissions] = Field(
-        default=UNSET
-    )
-    temp_clone_token: Missing[Union[str, None]] = Field(default=UNSET)
-    allow_merge_commit: Missing[bool] = Field(default=UNSET)
-    allow_squash_merge: Missing[bool] = Field(default=UNSET)
-    allow_rebase_merge: Missing[bool] = Field(default=UNSET)
-    license_: Union[PullRequestPropHeadPropRepoPropLicense, None] = Field(
-        alias="license"
-    )
-    pushed_at: datetime = Field()
-    size: int = Field()
-    ssh_url: str = Field()
-    stargazers_count: int = Field()
-    svn_url: str = Field()
-    topics: Missing[List[str]] = Field(default=UNSET)
-    watchers: int = Field()
-    watchers_count: int = Field()
-    created_at: datetime = Field()
-    updated_at: datetime = Field()
-    allow_forking: Missing[bool] = Field(default=UNSET)
-    is_template: Missing[bool] = Field(default=UNSET)
-    web_commit_signoff_required: Missing[bool] = Field(default=UNSET)
-
-
-class PullRequestPropHeadPropRepoPropOwner(GitHubModel):
-    """PullRequestPropHeadPropRepoPropOwner"""
-
-    avatar_url: str = Field()
-    events_url: str = Field()
-    followers_url: str = Field()
-    following_url: str = Field()
-    gists_url: str = Field()
-    gravatar_id: Union[str, None] = Field()
-    html_url: str = Field()
-    id: int = Field()
-    node_id: str = Field()
-    login: str = Field()
-    organizations_url: str = Field()
-    received_events_url: str = Field()
-    repos_url: str = Field()
-    site_admin: bool = Field()
-    starred_url: str = Field()
-    subscriptions_url: str = Field()
-    type: str = Field()
-    url: str = Field()
-
-
-class PullRequestPropHeadPropRepoPropPermissions(GitHubModel):
-    """PullRequestPropHeadPropRepoPropPermissions"""
-
-    admin: bool = Field()
-    maintain: Missing[bool] = Field(default=UNSET)
-    push: bool = Field()
-    triage: Missing[bool] = Field(default=UNSET)
-    pull: bool = Field()
-
-
-class PullRequestPropHeadPropRepoPropLicense(GitHubModel):
-    """PullRequestPropHeadPropRepoPropLicense"""
-
-    key: str = Field()
-    name: str = Field()
-    url: Union[str, None] = Field()
-    spdx_id: Union[str, None] = Field()
-    node_id: str = Field()
-
+class PageBuildStatus(GitHubModel):
+    """Page Build Status
 
-class PullRequestPropHeadPropUser(GitHubModel):
-    """PullRequestPropHeadPropUser"""
+    Page Build Status
+    """
 
-    avatar_url: str = Field()
-    events_url: str = Field()
-    followers_url: str = Field()
-    following_url: str = Field()
-    gists_url: str = Field()
-    gravatar_id: Union[str, None] = Field()
-    html_url: str = Field()
-    id: int = Field()
-    node_id: str = Field()
-    login: str = Field()
-    organizations_url: str = Field()
-    received_events_url: str = Field()
-    repos_url: str = Field()
-    site_admin: bool = Field()
-    starred_url: str = Field()
-    subscriptions_url: str = Field()
-    type: str = Field()
     url: str = Field()
+    status: str = Field()
 
 
-model_rebuild(PullRequestPropLabelsItems)
-model_rebuild(PullRequestPropHead)
-model_rebuild(PullRequestPropHeadPropRepo)
-model_rebuild(PullRequestPropHeadPropRepoPropOwner)
-model_rebuild(PullRequestPropHeadPropRepoPropPermissions)
-model_rebuild(PullRequestPropHeadPropRepoPropLicense)
-model_rebuild(PullRequestPropHeadPropUser)
+model_rebuild(PageBuildStatus)
 
-__all__ = (
-    "PullRequestPropLabelsItems",
-    "PullRequestPropHead",
-    "PullRequestPropHeadPropRepo",
-    "PullRequestPropHeadPropRepoPropOwner",
-    "PullRequestPropHeadPropRepoPropPermissions",
-    "PullRequestPropHeadPropRepoPropLicense",
-    "PullRequestPropHeadPropUser",
-)
+__all__ = ("PageBuildStatus",)

githubkit/versions/v2022_11_28/models/group_0300.py

@@ -13,48 +13,29 @@ from typing import Union
 
 from pydantic import Field
 
+from githubkit.utils import UNSET
+from githubkit.typing import Missing
 from githubkit.compat import GitHubModel, model_rebuild
 
-from .group_0301 import PullRequestPropBasePropRepo
-
-
-class PullRequestPropBase(GitHubModel):
-    """PullRequestPropBase"""
-
-    label: str = Field()
-    ref: str = Field()
-    repo: PullRequestPropBasePropRepo = Field()
-    sha: str = Field()
-    user: PullRequestPropBasePropUser = Field()
-
-
-class PullRequestPropBasePropUser(GitHubModel):
-    """PullRequestPropBasePropUser"""
-
-    avatar_url: str = Field()
-    events_url: str = Field()
-    followers_url: str = Field()
-    following_url: str = Field()
-    gists_url: str = Field()
-    gravatar_id: Union[str, None] = Field()
-    html_url: str = Field()
-    id: int = Field()
-    node_id: str = Field()
-    login: str = Field()
-    organizations_url: str = Field()
-    received_events_url: str = Field()
-    repos_url: str = Field()
-    site_admin: bool = Field()
-    starred_url: str = Field()
-    subscriptions_url: str = Field()
-    type: str = Field()
-    url: str = Field()
-
-
-model_rebuild(PullRequestPropBase)
-model_rebuild(PullRequestPropBasePropUser)
-
-__all__ = (
-    "PullRequestPropBase",
-    "PullRequestPropBasePropUser",
-)
+
+class PageDeployment(GitHubModel):
+    """GitHub Pages
+
+    The GitHub Pages deployment status.
+    """
+
+    id: Union[int, str] = Field(
+        description="The ID of the GitHub Pages deployment. This is the Git SHA of the deployed commit."
+    )
+    status_url: str = Field(
+        description="The URI to monitor GitHub Pages deployment status."
+    )
+    page_url: str = Field(description="The URI to the deployed GitHub Pages.")
+    preview_url: Missing[str] = Field(
+        default=UNSET, description="The URI to the deployed GitHub Pages preview."
+    )
+
+
+model_rebuild(PageDeployment)
+
+__all__ = ("PageDeployment",)