GitHubKit 0.12.4__py3-none-any.whl → 0.12.6__py3-none-any.whl

githubkit/versions/ghec_v2022_11_28/types/group_0309.py

@@ -9,13 +9,59 @@ See https://github.com/github/rest-api-description for more information.
 
 from __future__ import annotations
 
-from typing_extensions import TypedDict
+from datetime import datetime
+from typing import Any
+from typing_extensions import NotRequired, TypeAlias, TypedDict
 
+from .group_0306 import MetadataType
 
-class DeploymentBranchPolicyNamePatternType(TypedDict):
-    """Deployment branch policy name pattern"""
+
+class SnapshotType(TypedDict):
+    """snapshot
+
+    Create a new snapshot of a repository's dependencies.
+    """
+
+    version: int
+    job: SnapshotPropJobType
+    sha: str
+    ref: str
+    detector: SnapshotPropDetectorType
+    metadata: NotRequired[MetadataType]
+    manifests: NotRequired[SnapshotPropManifestsType]
+    scanned: datetime
+
+
+class SnapshotPropJobType(TypedDict):
+    """SnapshotPropJob"""
+
+    id: str
+    correlator: str
+    html_url: NotRequired[str]
+
+
+class SnapshotPropDetectorType(TypedDict):
+    """SnapshotPropDetector
+
+    A description of the detector used.
+    """
 
     name: str
+    version: str
+    url: str
+
+
+SnapshotPropManifestsType: TypeAlias = dict[str, Any]
+"""SnapshotPropManifests
+
+A collection of package manifests, which are a collection of related
+dependencies declared in a file or representing a logical group of dependencies.
+"""
 
 
-__all__ = ("DeploymentBranchPolicyNamePatternType",)
+__all__ = (
+    "SnapshotPropDetectorType",
+    "SnapshotPropJobType",
+    "SnapshotPropManifestsType",
+    "SnapshotType",
+)

githubkit/versions/ghec_v2022_11_28/types/group_0310.py

@@ -9,19 +9,37 @@ See https://github.com/github/rest-api-description for more information.
 
 from __future__ import annotations
 
-from typing_extensions import TypedDict
+from datetime import datetime
+from typing import Literal, Union
+from typing_extensions import NotRequired, TypedDict
 
+from .group_0003 import SimpleUserType
+from .group_0010 import IntegrationType
 
-class CustomDeploymentRuleAppType(TypedDict):
-    """Custom deployment protection rule app
 
-    A GitHub App that is providing a custom deployment protection rule.
+class DeploymentStatusType(TypedDict):
+    """Deployment Status
+
+    The status of a deployment.
     """
 
+    url: str
     id: int
-    slug: str
-    integration_url: str
     node_id: str
-
-
-__all__ = ("CustomDeploymentRuleAppType",)
+    state: Literal[
+        "error", "failure", "inactive", "pending", "success", "queued", "in_progress"
+    ]
+    creator: Union[None, SimpleUserType]
+    description: str
+    environment: NotRequired[str]
+    target_url: str
+    created_at: datetime
+    updated_at: datetime
+    deployment_url: str
+    repository_url: str
+    environment_url: NotRequired[str]
+    log_url: NotRequired[str]
+    performed_via_github_app: NotRequired[Union[None, IntegrationType, None]]
+
+
+__all__ = ("DeploymentStatusType",)

githubkit/versions/ghec_v2022_11_28/types/group_0311.py

@@ -9,37 +9,18 @@ See https://github.com/github/rest-api-description for more information.
 
 from __future__ import annotations
 
-from typing_extensions import NotRequired, TypedDict
+from typing_extensions import TypedDict
 
-from .group_0310 import CustomDeploymentRuleAppType
 
+class DeploymentBranchPolicySettingsType(TypedDict):
+    """DeploymentBranchPolicySettings
 
-class DeploymentProtectionRuleType(TypedDict):
-    """Deployment protection rule
-
-    Deployment protection rule
-    """
-
-    id: int
-    node_id: str
-    enabled: bool
-    app: CustomDeploymentRuleAppType
-
-
-class ReposOwnerRepoEnvironmentsEnvironmentNameDeploymentProtectionRulesGetResponse200Type(
-    TypedDict
-):
-    """ReposOwnerRepoEnvironmentsEnvironmentNameDeploymentProtectionRulesGetResponse200
-
-    Examples:
-        {'$ref': '#/components/examples/deployment-protection-rules'}
+    The type of deployment branch policy for this environment. To allow all branches
+    to deploy, set to `null`.
     """
 
-    total_count: NotRequired[int]
-    custom_deployment_protection_rules: NotRequired[list[DeploymentProtectionRuleType]]
+    protected_branches: bool
+    custom_branch_policies: bool
 
 
-__all__ = (
-    "DeploymentProtectionRuleType",
-    "ReposOwnerRepoEnvironmentsEnvironmentNameDeploymentProtectionRulesGetResponse200Type",
-)
+__all__ = ("DeploymentBranchPolicySettingsType",)

githubkit/versions/ghec_v2022_11_28/types/group_0312.py

@@ -9,17 +9,68 @@ See https://github.com/github/rest-api-description for more information.
 
 from __future__ import annotations
 
-from typing_extensions import TypedDict
+from datetime import datetime
+from typing import Union
+from typing_extensions import NotRequired, TypedDict
 
+from .group_0311 import DeploymentBranchPolicySettingsType
+from .group_0313 import EnvironmentPropProtectionRulesItemsAnyof1Type
 
-class ShortBlobType(TypedDict):
-    """Short Blob
 
-    Short Blob
+class EnvironmentType(TypedDict):
+    """Environment
+
+    Details of a deployment environment
     """
 
+    id: int
+    node_id: str
+    name: str
     url: str
-    sha: str
+    html_url: str
+    created_at: datetime
+    updated_at: datetime
+    protection_rules: NotRequired[
+        list[
+            Union[
+                EnvironmentPropProtectionRulesItemsAnyof0Type,
+                EnvironmentPropProtectionRulesItemsAnyof1Type,
+                EnvironmentPropProtectionRulesItemsAnyof2Type,
+            ]
+        ]
+    ]
+    deployment_branch_policy: NotRequired[
+        Union[DeploymentBranchPolicySettingsType, None]
+    ]
+
+
+class EnvironmentPropProtectionRulesItemsAnyof0Type(TypedDict):
+    """EnvironmentPropProtectionRulesItemsAnyof0"""
+
+    id: int
+    node_id: str
+    type: str
+    wait_timer: NotRequired[int]
+
+
+class EnvironmentPropProtectionRulesItemsAnyof2Type(TypedDict):
+    """EnvironmentPropProtectionRulesItemsAnyof2"""
+
+    id: int
+    node_id: str
+    type: str
+
+
+class ReposOwnerRepoEnvironmentsGetResponse200Type(TypedDict):
+    """ReposOwnerRepoEnvironmentsGetResponse200"""
+
+    total_count: NotRequired[int]
+    environments: NotRequired[list[EnvironmentType]]
 
 
-__all__ = ("ShortBlobType",)
+__all__ = (
+    "EnvironmentPropProtectionRulesItemsAnyof0Type",
+    "EnvironmentPropProtectionRulesItemsAnyof2Type",
+    "EnvironmentType",
+    "ReposOwnerRepoEnvironmentsGetResponse200Type",
+)

githubkit/versions/ghec_v2022_11_28/types/group_0313.py

@@ -9,23 +9,21 @@ See https://github.com/github/rest-api-description for more information.
 
 from __future__ import annotations
 
-from typing import Union
 from typing_extensions import NotRequired, TypedDict
 
+from .group_0314 import EnvironmentPropProtectionRulesItemsAnyof1PropReviewersItemsType
 
-class BlobType(TypedDict):
-    """Blob
 
-    Blob
-    """
+class EnvironmentPropProtectionRulesItemsAnyof1Type(TypedDict):
+    """EnvironmentPropProtectionRulesItemsAnyof1"""
 
-    content: str
-    encoding: str
-    url: str
-    sha: str
-    size: Union[int, None]
+    id: int
     node_id: str
-    highlighted_content: NotRequired[str]
+    prevent_self_review: NotRequired[bool]
+    type: str
+    reviewers: NotRequired[
+        list[EnvironmentPropProtectionRulesItemsAnyof1PropReviewersItemsType]
+    ]
 
 
-__all__ = ("BlobType",)
+__all__ = ("EnvironmentPropProtectionRulesItemsAnyof1Type",)

githubkit/versions/ghec_v2022_11_28/types/group_0314.py

@@ -9,81 +9,18 @@ See https://github.com/github/rest-api-description for more information.
 
 from __future__ import annotations
 
-from datetime import datetime
-from typing import Union
+from typing import Literal, Union
 from typing_extensions import NotRequired, TypedDict
 
+from .group_0003 import SimpleUserType
+from .group_0065 import TeamType
 
-class GitCommitType(TypedDict):
-    """Git Commit
 
-    Low-level Git commit operations within a repository
-    """
+class EnvironmentPropProtectionRulesItemsAnyof1PropReviewersItemsType(TypedDict):
+    """EnvironmentPropProtectionRulesItemsAnyof1PropReviewersItems"""
 
-    sha: str
-    node_id: str
-    url: str
-    author: GitCommitPropAuthorType
-    committer: GitCommitPropCommitterType
-    message: str
-    tree: GitCommitPropTreeType
-    parents: list[GitCommitPropParentsItemsType]
-    verification: GitCommitPropVerificationType
-    html_url: str
+    type: NotRequired[Literal["User", "Team"]]
+    reviewer: NotRequired[Union[SimpleUserType, TeamType]]
 
 
-class GitCommitPropAuthorType(TypedDict):
-    """GitCommitPropAuthor
-
-    Identifying information for the git-user
-    """
-
-    date: datetime
-    email: str
-    name: str
-
-
-class GitCommitPropCommitterType(TypedDict):
-    """GitCommitPropCommitter
-
-    Identifying information for the git-user
-    """
-
-    date: datetime
-    email: str
-    name: str
-
-
-class GitCommitPropTreeType(TypedDict):
-    """GitCommitPropTree"""
-
-    sha: str
-    url: str
-
-
-class GitCommitPropParentsItemsType(TypedDict):
-    """GitCommitPropParentsItems"""
-
-    sha: str
-    url: str
-    html_url: str
-
-
-class GitCommitPropVerificationType(TypedDict):
-    """GitCommitPropVerification"""
-
-    verified: bool
-    reason: str
-    signature: Union[str, None]
-    payload: Union[str, None]
-    verified_at: NotRequired[Union[str, None]]
-
-
-__all__ = (
-    "GitCommitPropAuthorType",
-    "GitCommitPropCommitterType",
-    "GitCommitPropParentsItemsType",
-    "GitCommitPropTreeType",
-    "GitCommitPropVerificationType",
-    "GitCommitType",
-)
+__all__ = ("EnvironmentPropProtectionRulesItemsAnyof1PropReviewersItemsType",)

githubkit/versions/ghec_v2022_11_28/types/group_0315.py

@@ -9,30 +9,15 @@ See https://github.com/github/rest-api-description for more information.
 
 from __future__ import annotations
 
-from typing_extensions import TypedDict
+from typing import Literal
+from typing_extensions import NotRequired, TypedDict
 
 
-class GitRefType(TypedDict):
-    """Git Reference
+class DeploymentBranchPolicyNamePatternWithTypeType(TypedDict):
+    """Deployment branch and tag policy name pattern"""
 
-    Git references within a repository
-    """
+    name: str
+    type: NotRequired[Literal["branch", "tag"]]
 
-    ref: str
-    node_id: str
-    url: str
-    object_: GitRefPropObjectType
 
-
-class GitRefPropObjectType(TypedDict):
-    """GitRefPropObject"""
-
-    type: str
-    sha: str
-    url: str
-
-
-__all__ = (
-    "GitRefPropObjectType",
-    "GitRefType",
-)
+__all__ = ("DeploymentBranchPolicyNamePatternWithTypeType",)

githubkit/versions/ghec_v2022_11_28/types/group_0316.py

@@ -9,45 +9,13 @@ See https://github.com/github/rest-api-description for more information.
 
 from __future__ import annotations
 
-from typing_extensions import NotRequired, TypedDict
+from typing_extensions import TypedDict
 
-from .group_0239 import VerificationType
 
+class DeploymentBranchPolicyNamePatternType(TypedDict):
+    """Deployment branch policy name pattern"""
 
-class GitTagType(TypedDict):
-    """Git Tag
-
-    Metadata for a Git tag
-    """
-
-    node_id: str
-    tag: str
-    sha: str
-    url: str
-    message: str
-    tagger: GitTagPropTaggerType
-    object_: GitTagPropObjectType
-    verification: NotRequired[VerificationType]
-
-
-class GitTagPropTaggerType(TypedDict):
-    """GitTagPropTagger"""
-
-    date: str
-    email: str
     name: str
 
 
-class GitTagPropObjectType(TypedDict):
-    """GitTagPropObject"""
-
-    sha: str
-    type: str
-    url: str
-
-
-__all__ = (
-    "GitTagPropObjectType",
-    "GitTagPropTaggerType",
-    "GitTagType",
-)
+__all__ = ("DeploymentBranchPolicyNamePatternType",)

githubkit/versions/ghec_v2022_11_28/types/group_0317.py

@@ -9,33 +9,19 @@ See https://github.com/github/rest-api-description for more information.
 
 from __future__ import annotations
 
-from typing_extensions import NotRequired, TypedDict
+from typing_extensions import TypedDict
 
 
-class GitTreeType(TypedDict):
-    """Git Tree
+class CustomDeploymentRuleAppType(TypedDict):
+    """Custom deployment protection rule app
 
-    The hierarchy between files in a Git repository.
+    A GitHub App that is providing a custom deployment protection rule.
     """
 
-    sha: str
-    url: str
-    truncated: bool
-    tree: list[GitTreePropTreeItemsType]
+    id: int
+    slug: str
+    integration_url: str
+    node_id: str
 
 
-class GitTreePropTreeItemsType(TypedDict):
-    """GitTreePropTreeItems"""
-
-    path: NotRequired[str]
-    mode: NotRequired[str]
-    type: NotRequired[str]
-    sha: NotRequired[str]
-    size: NotRequired[int]
-    url: NotRequired[str]
-
-
-__all__ = (
-    "GitTreePropTreeItemsType",
-    "GitTreeType",
-)
+__all__ = ("CustomDeploymentRuleAppType",)

githubkit/versions/ghec_v2022_11_28/types/group_0318.py

@@ -9,16 +9,37 @@ See https://github.com/github/rest-api-description for more information.
 
 from __future__ import annotations
 
-from typing import Union
-from typing_extensions import TypedDict
+from typing_extensions import NotRequired, TypedDict
 
+from .group_0317 import CustomDeploymentRuleAppType
 
-class HookResponseType(TypedDict):
-    """Hook Response"""
 
-    code: Union[int, None]
-    status: Union[str, None]
-    message: Union[str, None]
+class DeploymentProtectionRuleType(TypedDict):
+    """Deployment protection rule
 
+    Deployment protection rule
+    """
 
-__all__ = ("HookResponseType",)
+    id: int
+    node_id: str
+    enabled: bool
+    app: CustomDeploymentRuleAppType
+
+
+class ReposOwnerRepoEnvironmentsEnvironmentNameDeploymentProtectionRulesGetResponse200Type(
+    TypedDict
+):
+    """ReposOwnerRepoEnvironmentsEnvironmentNameDeploymentProtectionRulesGetResponse200
+
+    Examples:
+        {'$ref': '#/components/examples/deployment-protection-rules'}
+    """
+
+    total_count: NotRequired[int]
+    custom_deployment_protection_rules: NotRequired[list[DeploymentProtectionRuleType]]
+
+
+__all__ = (
+    "DeploymentProtectionRuleType",
+    "ReposOwnerRepoEnvironmentsEnvironmentNameDeploymentProtectionRulesGetResponse200Type",
+)

githubkit/versions/ghec_v2022_11_28/types/group_0319.py

@@ -9,32 +9,17 @@ See https://github.com/github/rest-api-description for more information.
 
 from __future__ import annotations
 
-from datetime import datetime
-from typing_extensions import NotRequired, TypedDict
+from typing_extensions import TypedDict
 
-from .group_0009 import WebhookConfigType
-from .group_0318 import HookResponseType
 
+class ShortBlobType(TypedDict):
+    """Short Blob
 
-class HookType(TypedDict):
-    """Webhook
-
-    Webhooks for repositories.
+    Short Blob
     """
 
-    type: str
-    id: int
-    name: str
-    active: bool
-    events: list[str]
-    config: WebhookConfigType
-    updated_at: datetime
-    created_at: datetime
     url: str
-    test_url: str
-    ping_url: str
-    deliveries_url: NotRequired[str]
-    last_response: HookResponseType
+    sha: str
 
 
-__all__ = ("HookType",)
+__all__ = ("ShortBlobType",)

githubkit/versions/ghec_v2022_11_28/types/group_0320.py

@@ -9,67 +9,23 @@ See https://github.com/github/rest-api-description for more information.
 
 from __future__ import annotations
 
-from typing import Literal, Union
+from typing import Union
 from typing_extensions import NotRequired, TypedDict
 
 
-class ImportType(TypedDict):
-    """Import
+class BlobType(TypedDict):
+    """Blob
 
-    A repository import from an external source.
+    Blob
     """
 
-    vcs: Union[str, None]
-    use_lfs: NotRequired[bool]
-    vcs_url: str
-    svc_root: NotRequired[str]
-    tfvc_project: NotRequired[str]
-    status: Literal[
-        "auth",
-        "error",
-        "none",
-        "detecting",
-        "choose",
-        "auth_failed",
-        "importing",
-        "mapping",
-        "waiting_to_push",
-        "pushing",
-        "complete",
-        "setup",
-        "unknown",
-        "detection_found_multiple",
-        "detection_found_nothing",
-        "detection_needs_auth",
-    ]
-    status_text: NotRequired[Union[str, None]]
-    failed_step: NotRequired[Union[str, None]]
-    error_message: NotRequired[Union[str, None]]
-    import_percent: NotRequired[Union[int, None]]
-    commit_count: NotRequired[Union[int, None]]
-    push_percent: NotRequired[Union[int, None]]
-    has_large_files: NotRequired[bool]
-    large_files_size: NotRequired[int]
-    large_files_count: NotRequired[int]
-    project_choices: NotRequired[list[ImportPropProjectChoicesItemsType]]
-    message: NotRequired[str]
-    authors_count: NotRequired[Union[int, None]]
+    content: str
+    encoding: str
     url: str
-    html_url: str
-    authors_url: str
-    repository_url: str
-    svn_root: NotRequired[str]
+    sha: str
+    size: Union[int, None]
+    node_id: str
+    highlighted_content: NotRequired[str]
 
 
-class ImportPropProjectChoicesItemsType(TypedDict):
-    """ImportPropProjectChoicesItems"""
-
-    vcs: NotRequired[str]
-    tfvc_project: NotRequired[str]
-    human_name: NotRequired[str]
-
-
-__all__ = (
-    "ImportPropProjectChoicesItemsType",
-    "ImportType",
-)
+__all__ = ("BlobType",)