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: 99e6da9a184b 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 get( 80 self, private_service_enrollment_id: str, *, org: str | None = None 81 ) -> PrivateServiceEnrollment: 82 """ 83 Retrieve a private service enrollment 84 85 Args: 86 private_service_enrollment_id: Canonical certificate-bound service identity. 87 org: Organization ID or slug. Required for developer and server callers. 88 89 Returns: 90 Successful response 91 """ 92 query: dict[str, object] = {} 93 if org is not None: 94 query["org"] = org 95 return await self._http.request( 96 f"/api/v1/private_service_enrollments/{private_service_enrollment_id}", 97 query=query, 98 response_type=PrivateServiceEnrollment, 99 ) 100 101 102class PrivateServiceEnrollmentResource: 103 def __init__(self, http: SyncHttpClient): 104 self._http = http 105 106 def list( 107 self, *, org: str | None = None, page: int | None = None, page_size: int | None = None 108 ) -> PrivateServiceEnrollmentPage: 109 """ 110 List private service enrollments 111 112 Args: 113 org: Organization ID or slug. Required for developer and server callers. 114 page: Page number. Defaults to 1. 115 page_size: Results per page. Defaults to 25; maximum is 100. 116 117 Returns: 118 Successful response 119 """ 120 query: dict[str, object] = {} 121 if org is not None: 122 query["org"] = org 123 if page is not None: 124 query["page"] = page 125 if page_size is not None: 126 query["page_size"] = page_size 127 return self._http.request( 128 "/api/v1/private_service_enrollments", 129 query=query, 130 response_type=PrivateServiceEnrollmentPage, 131 ) 132 133 def create(self, input: PrivateServiceEnrollmentCreateInput) -> CreatedPrivateServiceEnrollment: 134 """ 135 Create a private service enrollment 136 Creates or safely replaces an unreserved one-time connector enrollment token. 137 138 Args: 139 input: Request body. 140 input.org: Organization ID or slug. Required for developer and server callers. 141 input.private_service: Private service ID (`pvs_...`). 142 143 Returns: 144 Successful response 145 """ 146 return self._http.request( 147 "/api/v1/private_service_enrollments", 148 method="POST", 149 body=input, 150 response_type=CreatedPrivateServiceEnrollment, 151 ) 152 153 def get( 154 self, private_service_enrollment_id: str, *, org: str | None = None 155 ) -> PrivateServiceEnrollment: 156 """ 157 Retrieve a private service enrollment 158 159 Args: 160 private_service_enrollment_id: Canonical certificate-bound service identity. 161 org: Organization ID or slug. Required for developer and server callers. 162 163 Returns: 164 Successful response 165 """ 166 query: dict[str, object] = {} 167 if org is not None: 168 query["org"] = org 169 return self._http.request( 170 f"/api/v1/private_service_enrollments/{private_service_enrollment_id}", 171 query=query, 172 response_type=PrivateServiceEnrollment, 173 )
class
PrivateServiceEnrollmentCreateInput(typing.TypedDict):
18class PrivateServiceEnrollmentCreateInput(TypedDict, total=False): 19 "Create a private service enrollment" 20 21 org: str | None 22 "Organization ID or slug. Required for developer and server callers." 23 private_service: Required[str] 24 "Private service ID (`pvs_...`)."
Create a private service enrollment
class
AsyncPrivateServiceEnrollmentResource:
27class AsyncPrivateServiceEnrollmentResource: 28 def __init__(self, http: HttpClient): 29 self._http = http 30 31 async def list( 32 self, *, org: str | None = None, page: int | None = None, page_size: int | None = None 33 ) -> PrivateServiceEnrollmentPage: 34 """ 35 List private service enrollments 36 37 Args: 38 org: Organization ID or slug. Required for developer and server callers. 39 page: Page number. Defaults to 1. 40 page_size: Results per page. Defaults to 25; maximum is 100. 41 42 Returns: 43 Successful response 44 """ 45 query: dict[str, object] = {} 46 if org is not None: 47 query["org"] = org 48 if page is not None: 49 query["page"] = page 50 if page_size is not None: 51 query["page_size"] = page_size 52 return await self._http.request( 53 "/api/v1/private_service_enrollments", 54 query=query, 55 response_type=PrivateServiceEnrollmentPage, 56 ) 57 58 async def create( 59 self, input: PrivateServiceEnrollmentCreateInput 60 ) -> CreatedPrivateServiceEnrollment: 61 """ 62 Create a private service enrollment 63 Creates or safely replaces an unreserved one-time connector enrollment token. 64 65 Args: 66 input: Request body. 67 input.org: Organization ID or slug. Required for developer and server callers. 68 input.private_service: Private service ID (`pvs_...`). 69 70 Returns: 71 Successful response 72 """ 73 return await self._http.request( 74 "/api/v1/private_service_enrollments", 75 method="POST", 76 body=input, 77 response_type=CreatedPrivateServiceEnrollment, 78 ) 79 80 async def get( 81 self, private_service_enrollment_id: str, *, org: str | None = None 82 ) -> PrivateServiceEnrollment: 83 """ 84 Retrieve a private service enrollment 85 86 Args: 87 private_service_enrollment_id: Canonical certificate-bound service identity. 88 org: Organization ID or slug. Required for developer and server callers. 89 90 Returns: 91 Successful response 92 """ 93 query: dict[str, object] = {} 94 if org is not None: 95 query["org"] = org 96 return await self._http.request( 97 f"/api/v1/private_service_enrollments/{private_service_enrollment_id}", 98 query=query, 99 response_type=PrivateServiceEnrollment, 100 )
AsyncPrivateServiceEnrollmentResource(http: archastro.platform.runtime.http_client.HttpClient)
async def
list( self, *, org: str | None = None, page: int | None = None, page_size: int | None = None) -> archastro.platform.types.common.PrivateServiceEnrollmentPage:
31 async def list( 32 self, *, org: str | None = None, page: int | None = None, page_size: int | None = None 33 ) -> PrivateServiceEnrollmentPage: 34 """ 35 List private service enrollments 36 37 Args: 38 org: Organization ID or slug. Required for developer and server callers. 39 page: Page number. Defaults to 1. 40 page_size: Results per page. Defaults to 25; maximum is 100. 41 42 Returns: 43 Successful response 44 """ 45 query: dict[str, object] = {} 46 if org is not None: 47 query["org"] = org 48 if page is not None: 49 query["page"] = page 50 if page_size is not None: 51 query["page_size"] = page_size 52 return await self._http.request( 53 "/api/v1/private_service_enrollments", 54 query=query, 55 response_type=PrivateServiceEnrollmentPage, 56 )
List private service enrollments
Arguments:
- org: Organization ID or slug. Required for developer and server callers.
- page: Page number. Defaults to 1.
- page_size: Results per page. Defaults to 25; maximum is 100.
Returns:
Successful response
async def
create( self, input: PrivateServiceEnrollmentCreateInput) -> archastro.platform.types.common.CreatedPrivateServiceEnrollment:
58 async def create( 59 self, input: PrivateServiceEnrollmentCreateInput 60 ) -> CreatedPrivateServiceEnrollment: 61 """ 62 Create a private service enrollment 63 Creates or safely replaces an unreserved one-time connector enrollment token. 64 65 Args: 66 input: Request body. 67 input.org: Organization ID or slug. Required for developer and server callers. 68 input.private_service: Private service ID (`pvs_...`). 69 70 Returns: 71 Successful response 72 """ 73 return await self._http.request( 74 "/api/v1/private_service_enrollments", 75 method="POST", 76 body=input, 77 response_type=CreatedPrivateServiceEnrollment, 78 )
Create a private service enrollment Creates or safely replaces an unreserved one-time connector enrollment token.
Arguments:
- input: Request body.
- input.org: Organization ID or slug. Required for developer and server callers.
- input.private_service: Private service ID (
pvs_...).
Returns:
Successful response
async def
get( self, private_service_enrollment_id: str, *, org: str | None = None) -> archastro.platform.types.common.PrivateServiceEnrollment:
80 async def get( 81 self, private_service_enrollment_id: str, *, org: str | None = None 82 ) -> PrivateServiceEnrollment: 83 """ 84 Retrieve a private service enrollment 85 86 Args: 87 private_service_enrollment_id: Canonical certificate-bound service identity. 88 org: Organization ID or slug. Required for developer and server callers. 89 90 Returns: 91 Successful response 92 """ 93 query: dict[str, object] = {} 94 if org is not None: 95 query["org"] = org 96 return await self._http.request( 97 f"/api/v1/private_service_enrollments/{private_service_enrollment_id}", 98 query=query, 99 response_type=PrivateServiceEnrollment, 100 )
Retrieve a private service enrollment
Arguments:
- private_service_enrollment_id: Canonical certificate-bound service identity.
- org: Organization ID or slug. Required for developer and server callers.
Returns:
Successful response
class
PrivateServiceEnrollmentResource:
103class PrivateServiceEnrollmentResource: 104 def __init__(self, http: SyncHttpClient): 105 self._http = http 106 107 def list( 108 self, *, org: str | None = None, page: int | None = None, page_size: int | None = None 109 ) -> PrivateServiceEnrollmentPage: 110 """ 111 List private service enrollments 112 113 Args: 114 org: Organization ID or slug. Required for developer and server callers. 115 page: Page number. Defaults to 1. 116 page_size: Results per page. Defaults to 25; maximum is 100. 117 118 Returns: 119 Successful response 120 """ 121 query: dict[str, object] = {} 122 if org is not None: 123 query["org"] = org 124 if page is not None: 125 query["page"] = page 126 if page_size is not None: 127 query["page_size"] = page_size 128 return self._http.request( 129 "/api/v1/private_service_enrollments", 130 query=query, 131 response_type=PrivateServiceEnrollmentPage, 132 ) 133 134 def create(self, input: PrivateServiceEnrollmentCreateInput) -> CreatedPrivateServiceEnrollment: 135 """ 136 Create a private service enrollment 137 Creates or safely replaces an unreserved one-time connector enrollment token. 138 139 Args: 140 input: Request body. 141 input.org: Organization ID or slug. Required for developer and server callers. 142 input.private_service: Private service ID (`pvs_...`). 143 144 Returns: 145 Successful response 146 """ 147 return self._http.request( 148 "/api/v1/private_service_enrollments", 149 method="POST", 150 body=input, 151 response_type=CreatedPrivateServiceEnrollment, 152 ) 153 154 def get( 155 self, private_service_enrollment_id: str, *, org: str | None = None 156 ) -> PrivateServiceEnrollment: 157 """ 158 Retrieve a private service enrollment 159 160 Args: 161 private_service_enrollment_id: Canonical certificate-bound service identity. 162 org: Organization ID or slug. Required for developer and server callers. 163 164 Returns: 165 Successful response 166 """ 167 query: dict[str, object] = {} 168 if org is not None: 169 query["org"] = org 170 return self._http.request( 171 f"/api/v1/private_service_enrollments/{private_service_enrollment_id}", 172 query=query, 173 response_type=PrivateServiceEnrollment, 174 )
PrivateServiceEnrollmentResource(http: archastro.platform.runtime.http_client.SyncHttpClient)
def
list( self, *, org: str | None = None, page: int | None = None, page_size: int | None = None) -> archastro.platform.types.common.PrivateServiceEnrollmentPage:
107 def list( 108 self, *, org: str | None = None, page: int | None = None, page_size: int | None = None 109 ) -> PrivateServiceEnrollmentPage: 110 """ 111 List private service enrollments 112 113 Args: 114 org: Organization ID or slug. Required for developer and server callers. 115 page: Page number. Defaults to 1. 116 page_size: Results per page. Defaults to 25; maximum is 100. 117 118 Returns: 119 Successful response 120 """ 121 query: dict[str, object] = {} 122 if org is not None: 123 query["org"] = org 124 if page is not None: 125 query["page"] = page 126 if page_size is not None: 127 query["page_size"] = page_size 128 return self._http.request( 129 "/api/v1/private_service_enrollments", 130 query=query, 131 response_type=PrivateServiceEnrollmentPage, 132 )
List private service enrollments
Arguments:
- org: Organization ID or slug. Required for developer and server callers.
- page: Page number. Defaults to 1.
- page_size: Results per page. Defaults to 25; maximum is 100.
Returns:
Successful response
def
create( self, input: PrivateServiceEnrollmentCreateInput) -> archastro.platform.types.common.CreatedPrivateServiceEnrollment:
134 def create(self, input: PrivateServiceEnrollmentCreateInput) -> CreatedPrivateServiceEnrollment: 135 """ 136 Create a private service enrollment 137 Creates or safely replaces an unreserved one-time connector enrollment token. 138 139 Args: 140 input: Request body. 141 input.org: Organization ID or slug. Required for developer and server callers. 142 input.private_service: Private service ID (`pvs_...`). 143 144 Returns: 145 Successful response 146 """ 147 return self._http.request( 148 "/api/v1/private_service_enrollments", 149 method="POST", 150 body=input, 151 response_type=CreatedPrivateServiceEnrollment, 152 )
Create a private service enrollment Creates or safely replaces an unreserved one-time connector enrollment token.
Arguments:
- input: Request body.
- input.org: Organization ID or slug. Required for developer and server callers.
- input.private_service: Private service ID (
pvs_...).
Returns:
Successful response
def
get( self, private_service_enrollment_id: str, *, org: str | None = None) -> archastro.platform.types.common.PrivateServiceEnrollment:
154 def get( 155 self, private_service_enrollment_id: str, *, org: str | None = None 156 ) -> PrivateServiceEnrollment: 157 """ 158 Retrieve a private service enrollment 159 160 Args: 161 private_service_enrollment_id: Canonical certificate-bound service identity. 162 org: Organization ID or slug. Required for developer and server callers. 163 164 Returns: 165 Successful response 166 """ 167 query: dict[str, object] = {} 168 if org is not None: 169 query["org"] = org 170 return self._http.request( 171 f"/api/v1/private_service_enrollments/{private_service_enrollment_id}", 172 query=query, 173 response_type=PrivateServiceEnrollment, 174 )
Retrieve a private service enrollment
Arguments:
- private_service_enrollment_id: Canonical certificate-bound service identity.
- org: Organization ID or slug. Required for developer and server callers.
Returns:
Successful response