archastro.platform.v1.resources.private_service_enrollments

  1# Copyright (c) 2026 ArchAstro Inc. Licensed under the MIT License.
  2# This file is auto-generated by @archastro/sdk-generator. Do not edit.
  3# Content hash: 35906c269bf3
  4
  5from __future__ import annotations
  6
  7from typing import Required, TypedDict
  8
  9from ...runtime.http_client import HttpClient, SyncHttpClient
 10from ...types.common import (
 11    CreatedPrivateServiceEnrollment,
 12    PrivateServiceEnrollment,
 13    PrivateServiceEnrollmentPage,
 14)
 15
 16
 17class PrivateServiceEnrollmentCreateInput(TypedDict, total=False):
 18    "Create a private service enrollment"
 19
 20    org: str | None
 21    "Organization ID or slug. Required for developer and server callers."
 22    private_service: Required[str]
 23    "Private service ID (`pvs_...`)."
 24
 25
 26class AsyncPrivateServiceEnrollmentResource:
 27    def __init__(self, http: HttpClient):
 28        self._http = http
 29
 30    async def list(
 31        self, *, org: str | None = None, page: int | None = None, page_size: int | None = None
 32    ) -> PrivateServiceEnrollmentPage:
 33        """
 34        List private service enrollments
 35
 36        Args:
 37            org: Organization ID or slug. Required for developer and server callers.
 38            page: Page number. Defaults to 1.
 39            page_size: Results per page. Defaults to 25; maximum is 100.
 40
 41        Returns:
 42            Successful response
 43        """
 44        query: dict[str, object] = {}
 45        if org is not None:
 46            query["org"] = org
 47        if page is not None:
 48            query["page"] = page
 49        if page_size is not None:
 50            query["page_size"] = page_size
 51        return await self._http.request(
 52            "/api/v1/private_service_enrollments",
 53            query=query,
 54            response_type=PrivateServiceEnrollmentPage,
 55        )
 56
 57    async def create(
 58        self, input: PrivateServiceEnrollmentCreateInput
 59    ) -> CreatedPrivateServiceEnrollment:
 60        """
 61        Create a private service enrollment
 62        Creates or safely replaces an unreserved one-time connector enrollment token.
 63
 64        Args:
 65            input: Request body.
 66            input.org: Organization ID or slug. Required for developer and server callers.
 67            input.private_service: Private service ID (`pvs_...`).
 68
 69        Returns:
 70            Successful response
 71        """
 72        return await self._http.request(
 73            "/api/v1/private_service_enrollments",
 74            method="POST",
 75            body=input,
 76            response_type=CreatedPrivateServiceEnrollment,
 77        )
 78
 79    async def delete(self, private_service_enrollment_id: str) -> None:
 80        """
 81        Revoke a private service enrollment
 82        Removes online connector authorization and prevents credential renewal.
 83
 84        Args:
 85            private_service_enrollment_id: Canonical certificate-bound service identity.
 86
 87        Returns:
 88            Authorization was durably revoked.
 89        """
 90        await self._http.request(
 91            f"/api/v1/private_service_enrollments/{private_service_enrollment_id}",
 92            method="DELETE",
 93        )
 94
 95    async def get(
 96        self, private_service_enrollment_id: str, *, org: str | None = None
 97    ) -> PrivateServiceEnrollment:
 98        """
 99        Retrieve a private service enrollment
100
101        Args:
102            private_service_enrollment_id: Canonical certificate-bound service identity.
103            org: Organization ID or slug. Required for developer and server callers.
104
105        Returns:
106            Successful response
107        """
108        query: dict[str, object] = {}
109        if org is not None:
110            query["org"] = org
111        return await self._http.request(
112            f"/api/v1/private_service_enrollments/{private_service_enrollment_id}",
113            query=query,
114            response_type=PrivateServiceEnrollment,
115        )
116
117
118class PrivateServiceEnrollmentResource:
119    def __init__(self, http: SyncHttpClient):
120        self._http = http
121
122    def list(
123        self, *, org: str | None = None, page: int | None = None, page_size: int | None = None
124    ) -> PrivateServiceEnrollmentPage:
125        """
126        List private service enrollments
127
128        Args:
129            org: Organization ID or slug. Required for developer and server callers.
130            page: Page number. Defaults to 1.
131            page_size: Results per page. Defaults to 25; maximum is 100.
132
133        Returns:
134            Successful response
135        """
136        query: dict[str, object] = {}
137        if org is not None:
138            query["org"] = org
139        if page is not None:
140            query["page"] = page
141        if page_size is not None:
142            query["page_size"] = page_size
143        return self._http.request(
144            "/api/v1/private_service_enrollments",
145            query=query,
146            response_type=PrivateServiceEnrollmentPage,
147        )
148
149    def create(self, input: PrivateServiceEnrollmentCreateInput) -> CreatedPrivateServiceEnrollment:
150        """
151        Create a private service enrollment
152        Creates or safely replaces an unreserved one-time connector enrollment token.
153
154        Args:
155            input: Request body.
156            input.org: Organization ID or slug. Required for developer and server callers.
157            input.private_service: Private service ID (`pvs_...`).
158
159        Returns:
160            Successful response
161        """
162        return self._http.request(
163            "/api/v1/private_service_enrollments",
164            method="POST",
165            body=input,
166            response_type=CreatedPrivateServiceEnrollment,
167        )
168
169    def delete(self, private_service_enrollment_id: str) -> None:
170        """
171        Revoke a private service enrollment
172        Removes online connector authorization and prevents credential renewal.
173
174        Args:
175            private_service_enrollment_id: Canonical certificate-bound service identity.
176
177        Returns:
178            Authorization was durably revoked.
179        """
180        self._http.request(
181            f"/api/v1/private_service_enrollments/{private_service_enrollment_id}",
182            method="DELETE",
183        )
184
185    def get(
186        self, private_service_enrollment_id: str, *, org: str | None = None
187    ) -> PrivateServiceEnrollment:
188        """
189        Retrieve a private service enrollment
190
191        Args:
192            private_service_enrollment_id: Canonical certificate-bound service identity.
193            org: Organization ID or slug. Required for developer and server callers.
194
195        Returns:
196            Successful response
197        """
198        query: dict[str, object] = {}
199        if org is not None:
200            query["org"] = org
201        return self._http.request(
202            f"/api/v1/private_service_enrollments/{private_service_enrollment_id}",
203            query=query,
204            response_type=PrivateServiceEnrollment,
205        )