proofline-sdk 1.0.0__py3-none-any.whl

proofline/__init__.py

@@ -0,0 +1,60 @@
+"""Typed clients for the bearer-authorized Proofline review API."""
+
+from pydantic import SecretStr
+
+from ._generated import models
+from ._generated.models import (
+    AgentSession,
+    AgentVendor,
+    CommitReviewRequest,
+    CommitReviewResponse,
+    CustomerAssessmentDetail,
+    CustomerFinding,
+    CustomerReviewDetail,
+    PatchReviewRequest,
+    PatchReviewResponse,
+    PatchTriggerSource,
+    RepositoryGuidance,
+    RepositoryNames,
+    RerunResponse,
+    ReviewPage,
+    RunNowMode,
+    RunNowRequest,
+    RunNowResponse,
+    StartSession,
+)
+from ._transport import VERSION as __version__
+from ._transport import ProoflineError
+from .client import AsyncProoflineClient, ProoflineClient, ReviewFilters
+from .outcomes import AssessmentGap, CheckGap, ReviewOutcome
+
+__all__ = [
+    "AgentSession",
+    "AgentVendor",
+    "AssessmentGap",
+    "AsyncProoflineClient",
+    "CheckGap",
+    "CommitReviewRequest",
+    "CommitReviewResponse",
+    "CustomerAssessmentDetail",
+    "CustomerFinding",
+    "CustomerReviewDetail",
+    "PatchReviewRequest",
+    "PatchReviewResponse",
+    "PatchTriggerSource",
+    "ProoflineClient",
+    "ProoflineError",
+    "RepositoryGuidance",
+    "RepositoryNames",
+    "RerunResponse",
+    "ReviewFilters",
+    "ReviewOutcome",
+    "ReviewPage",
+    "RunNowMode",
+    "RunNowRequest",
+    "RunNowResponse",
+    "SecretStr",
+    "StartSession",
+    "__version__",
+    "models",
+]

proofline/_generated/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Triax Technologies
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

proofline/_generated/__init__.py

@@ -0,0 +1,8 @@
+"""A client library for accessing Proofline Review API"""
+
+from .client import AuthenticatedClient, Client
+
+__all__ = (
+    "AuthenticatedClient",
+    "Client",
+)

proofline/_generated/api/__init__.py

@@ -0,0 +1 @@
+"""Contains methods for accessing the API"""

proofline/_generated/api/default/__init__.py

@@ -0,0 +1 @@
+"""Contains endpoint functions for accessing the API"""

proofline/_generated/api/default/get_agent_session.py

@@ -0,0 +1,180 @@
+from http import HTTPStatus
+from typing import Any
+from urllib.parse import quote
+from uuid import UUID
+
+import httpx
+
+from ...client import AuthenticatedClient, Client
+from ...models.agent_session import AgentSession
+from ...models.problem import Problem
+from ...types import Response
+
+
+def _get_kwargs(
+    org_id: UUID,
+    session_id: UUID,
+) -> dict[str, Any]:
+    _kwargs: dict[str, Any] = {
+        "method": "get",
+        "url": "/api/v1/organizations/{org_id}/agent-sessions/{session_id}".format(
+            org_id=quote(str(org_id), safe=""),
+            session_id=quote(str(session_id), safe=""),
+        ),
+    }
+
+    return _kwargs
+
+
+def _parse_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> AgentSession | Problem:
+    if response.status_code == 200:
+        response_200 = AgentSession.from_dict(response.json())
+
+        return response_200
+
+    response_default = Problem.from_dict(response.json())
+
+    return response_default
+
+
+def _build_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> Response[AgentSession | Problem]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    org_id: UUID,
+    session_id: UUID,
+    *,
+    client: AuthenticatedClient,
+) -> Response[AgentSession | Problem]:
+    """Get a coding-agent session
+
+     Returns a coding-agent session's latest status, its vendor link, its untrusted vendor summary and
+    the pull request GitHub confirmed it opened in the target repository.
+
+    Args:
+        org_id (UUID):
+        session_id (UUID):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[AgentSession | Problem]
+    """
+
+    kwargs = _get_kwargs(
+        org_id=org_id,
+        session_id=session_id,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    org_id: UUID,
+    session_id: UUID,
+    *,
+    client: AuthenticatedClient,
+) -> AgentSession | Problem | None:
+    """Get a coding-agent session
+
+     Returns a coding-agent session's latest status, its vendor link, its untrusted vendor summary and
+    the pull request GitHub confirmed it opened in the target repository.
+
+    Args:
+        org_id (UUID):
+        session_id (UUID):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        AgentSession | Problem
+    """
+
+    return sync_detailed(
+        org_id=org_id,
+        session_id=session_id,
+        client=client,
+    ).parsed
+
+
+async def asyncio_detailed(
+    org_id: UUID,
+    session_id: UUID,
+    *,
+    client: AuthenticatedClient,
+) -> Response[AgentSession | Problem]:
+    """Get a coding-agent session
+
+     Returns a coding-agent session's latest status, its vendor link, its untrusted vendor summary and
+    the pull request GitHub confirmed it opened in the target repository.
+
+    Args:
+        org_id (UUID):
+        session_id (UUID):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[AgentSession | Problem]
+    """
+
+    kwargs = _get_kwargs(
+        org_id=org_id,
+        session_id=session_id,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    org_id: UUID,
+    session_id: UUID,
+    *,
+    client: AuthenticatedClient,
+) -> AgentSession | Problem | None:
+    """Get a coding-agent session
+
+     Returns a coding-agent session's latest status, its vendor link, its untrusted vendor summary and
+    the pull request GitHub confirmed it opened in the target repository.
+
+    Args:
+        org_id (UUID):
+        session_id (UUID):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        AgentSession | Problem
+    """
+
+    return (
+        await asyncio_detailed(
+            org_id=org_id,
+            session_id=session_id,
+            client=client,
+        )
+    ).parsed

proofline/_generated/api/default/get_agent_session_prompt.py

@@ -0,0 +1,203 @@
+from http import HTTPStatus
+from typing import Any
+from urllib.parse import quote
+from uuid import UUID
+
+import httpx
+
+from ...client import AuthenticatedClient, Client
+from ...models.agent_session_prompt_type_0 import AgentSessionPromptType0
+from ...models.agent_session_prompt_type_1 import AgentSessionPromptType1
+from ...models.problem import Problem
+from ...types import Response
+
+
+def _get_kwargs(
+    org_id: UUID,
+    finding_id: UUID,
+) -> dict[str, Any]:
+    _kwargs: dict[str, Any] = {
+        "method": "get",
+        "url": "/api/v1/organizations/{org_id}/findings/{finding_id}/agent-session-prompt".format(
+            org_id=quote(str(org_id), safe=""),
+            finding_id=quote(str(finding_id), safe=""),
+        ),
+    }
+
+    return _kwargs
+
+
+def _parse_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> AgentSessionPromptType0 | AgentSessionPromptType1 | Problem:
+    if response.status_code == 200:
+
+        def _parse_response_200(data: object) -> AgentSessionPromptType0 | AgentSessionPromptType1:
+            try:
+                if not isinstance(data, dict):
+                    raise TypeError()
+                componentsschemas_agent_session_prompt_type_0 = AgentSessionPromptType0.from_dict(
+                    data
+                )
+
+                return componentsschemas_agent_session_prompt_type_0
+            except (TypeError, ValueError, AttributeError, KeyError):
+                pass
+            if not isinstance(data, dict):
+                raise TypeError()
+            componentsschemas_agent_session_prompt_type_1 = AgentSessionPromptType1.from_dict(data)
+
+            return componentsschemas_agent_session_prompt_type_1
+
+        response_200 = _parse_response_200(response.json())
+
+        return response_200
+
+    response_default = Problem.from_dict(response.json())
+
+    return response_default
+
+
+def _build_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> Response[AgentSessionPromptType0 | AgentSessionPromptType1 | Problem]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    org_id: UUID,
+    finding_id: UUID,
+    *,
+    client: AuthenticatedClient,
+) -> Response[AgentSessionPromptType0 | AgentSessionPromptType1 | Problem]:
+    """Preview a coding-agent session
+
+     Returns the exact prompt and target a coding-agent session on this pull request finding would send,
+    with every protected value withheld, and the prompt digest a start names. Requires access to every
+    repository in the review.
+
+    Args:
+        org_id (UUID):
+        finding_id (UUID):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[AgentSessionPromptType0 | AgentSessionPromptType1 | Problem]
+    """
+
+    kwargs = _get_kwargs(
+        org_id=org_id,
+        finding_id=finding_id,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    org_id: UUID,
+    finding_id: UUID,
+    *,
+    client: AuthenticatedClient,
+) -> AgentSessionPromptType0 | AgentSessionPromptType1 | Problem | None:
+    """Preview a coding-agent session
+
+     Returns the exact prompt and target a coding-agent session on this pull request finding would send,
+    with every protected value withheld, and the prompt digest a start names. Requires access to every
+    repository in the review.
+
+    Args:
+        org_id (UUID):
+        finding_id (UUID):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        AgentSessionPromptType0 | AgentSessionPromptType1 | Problem
+    """
+
+    return sync_detailed(
+        org_id=org_id,
+        finding_id=finding_id,
+        client=client,
+    ).parsed
+
+
+async def asyncio_detailed(
+    org_id: UUID,
+    finding_id: UUID,
+    *,
+    client: AuthenticatedClient,
+) -> Response[AgentSessionPromptType0 | AgentSessionPromptType1 | Problem]:
+    """Preview a coding-agent session
+
+     Returns the exact prompt and target a coding-agent session on this pull request finding would send,
+    with every protected value withheld, and the prompt digest a start names. Requires access to every
+    repository in the review.
+
+    Args:
+        org_id (UUID):
+        finding_id (UUID):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[AgentSessionPromptType0 | AgentSessionPromptType1 | Problem]
+    """
+
+    kwargs = _get_kwargs(
+        org_id=org_id,
+        finding_id=finding_id,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    org_id: UUID,
+    finding_id: UUID,
+    *,
+    client: AuthenticatedClient,
+) -> AgentSessionPromptType0 | AgentSessionPromptType1 | Problem | None:
+    """Preview a coding-agent session
+
+     Returns the exact prompt and target a coding-agent session on this pull request finding would send,
+    with every protected value withheld, and the prompt digest a start names. Requires access to every
+    repository in the review.
+
+    Args:
+        org_id (UUID):
+        finding_id (UUID):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        AgentSessionPromptType0 | AgentSessionPromptType1 | Problem
+    """
+
+    return (
+        await asyncio_detailed(
+            org_id=org_id,
+            finding_id=finding_id,
+            client=client,
+        )
+    ).parsed

proofline/_generated/api/default/get_assessment.py

@@ -0,0 +1,190 @@
+from http import HTTPStatus
+from typing import Any
+from urllib.parse import quote
+from uuid import UUID
+
+import httpx
+
+from ...client import AuthenticatedClient, Client
+from ...models.customer_assessment_detail import CustomerAssessmentDetail
+from ...models.problem import Problem
+from ...types import Response
+
+
+def _get_kwargs(
+    org_id: UUID,
+    review_id: UUID,
+    assessment_id: UUID,
+) -> dict[str, Any]:
+    _kwargs: dict[str, Any] = {
+        "method": "get",
+        "url": "/api/v1/organizations/{org_id}/reviews/{review_id}/assessments/{assessment_id}".format(
+            org_id=quote(str(org_id), safe=""),
+            review_id=quote(str(review_id), safe=""),
+            assessment_id=quote(str(assessment_id), safe=""),
+        ),
+    }
+
+    return _kwargs
+
+
+def _parse_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> CustomerAssessmentDetail | Problem:
+    if response.status_code == 200:
+        response_200 = CustomerAssessmentDetail.from_dict(response.json())
+
+        return response_200
+
+    response_default = Problem.from_dict(response.json())
+
+    return response_default
+
+
+def _build_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> Response[CustomerAssessmentDetail | Problem]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    org_id: UUID,
+    review_id: UUID,
+    assessment_id: UUID,
+    *,
+    client: AuthenticatedClient,
+) -> Response[CustomerAssessmentDetail | Problem]:
+    """Get an assessment
+
+     Returns one assessment of a review with its decision, checks and findings.
+
+    Args:
+        org_id (UUID):
+        review_id (UUID):
+        assessment_id (UUID):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[CustomerAssessmentDetail | Problem]
+    """
+
+    kwargs = _get_kwargs(
+        org_id=org_id,
+        review_id=review_id,
+        assessment_id=assessment_id,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    org_id: UUID,
+    review_id: UUID,
+    assessment_id: UUID,
+    *,
+    client: AuthenticatedClient,
+) -> CustomerAssessmentDetail | Problem | None:
+    """Get an assessment
+
+     Returns one assessment of a review with its decision, checks and findings.
+
+    Args:
+        org_id (UUID):
+        review_id (UUID):
+        assessment_id (UUID):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        CustomerAssessmentDetail | Problem
+    """
+
+    return sync_detailed(
+        org_id=org_id,
+        review_id=review_id,
+        assessment_id=assessment_id,
+        client=client,
+    ).parsed
+
+
+async def asyncio_detailed(
+    org_id: UUID,
+    review_id: UUID,
+    assessment_id: UUID,
+    *,
+    client: AuthenticatedClient,
+) -> Response[CustomerAssessmentDetail | Problem]:
+    """Get an assessment
+
+     Returns one assessment of a review with its decision, checks and findings.
+
+    Args:
+        org_id (UUID):
+        review_id (UUID):
+        assessment_id (UUID):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[CustomerAssessmentDetail | Problem]
+    """
+
+    kwargs = _get_kwargs(
+        org_id=org_id,
+        review_id=review_id,
+        assessment_id=assessment_id,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    org_id: UUID,
+    review_id: UUID,
+    assessment_id: UUID,
+    *,
+    client: AuthenticatedClient,
+) -> CustomerAssessmentDetail | Problem | None:
+    """Get an assessment
+
+     Returns one assessment of a review with its decision, checks and findings.
+
+    Args:
+        org_id (UUID):
+        review_id (UUID):
+        assessment_id (UUID):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        CustomerAssessmentDetail | Problem
+    """
+
+    return (
+        await asyncio_detailed(
+            org_id=org_id,
+            review_id=review_id,
+            assessment_id=assessment_id,
+            client=client,
+        )
+    ).parsed