archastro.platform.v1.resources.private_services

  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: d9f86ab03baa
  4
  5from __future__ import annotations
  6
  7from typing import Any, Required, TypedDict
  8
  9from ...runtime.http_client import HttpClient, SyncHttpClient
 10from ...types.common import PrivateService, PrivateServicePage
 11
 12
 13class PrivateServiceCreateInputFunctionsItem(TypedDict, total=False):
 14    description: Required[str]
 15    "Human-readable guidance describing when and why to call the operation."
 16    input_schema: Required[dict[str, Any]]
 17    "JSON Schema Draft 7 object describing the operation's argument object."
 18    name: Required[str]
 19    "Stable operation name used when invoking the private service."
 20    output_schema: dict[str, Any] | None
 21    "Optional JSON Schema Draft 7 object describing the successful result."
 22
 23
 24class PrivateServiceCreateInput(TypedDict, total=False):
 25    "Create a private service"
 26
 27    functions: Required[list[PrivateServiceCreateInputFunctionsItem]]
 28    "Complete callable contracts. Input schemas are required; output schemas are optional."
 29    org: str | None
 30    "Organization ID or slug. Required for developer and server callers."
 31
 32
 33class AsyncPrivateServiceResource:
 34    def __init__(self, http: HttpClient):
 35        self._http = http
 36
 37    async def list(
 38        self, *, org: str | None = None, page: int | None = None, page_size: int | None = None
 39    ) -> PrivateServicePage:
 40        """
 41        List private services
 42
 43        Args:
 44            org: Organization ID or slug. Required for developer and server callers.
 45            page: Page number. Defaults to 1.
 46            page_size: Results per page. Defaults to 25; maximum is 100.
 47
 48        Returns:
 49            Successful response
 50        """
 51        query: dict[str, object] = {}
 52        if org is not None:
 53            query["org"] = org
 54        if page is not None:
 55            query["page"] = page
 56        if page_size is not None:
 57            query["page_size"] = page_size
 58        return await self._http.request(
 59            "/api/v1/private_services",
 60            query=query,
 61            response_type=PrivateServicePage,
 62        )
 63
 64    async def create(self, input: PrivateServiceCreateInput) -> PrivateService:
 65        """
 66        Create a private service
 67        Creates one immutable private service in the selected organization.
 68
 69        Args:
 70            input: Request body.
 71            input.functions: Complete callable contracts. Input schemas are required; output schemas are optional.
 72            input.org: Organization ID or slug. Required for developer and server callers.
 73
 74        Returns:
 75            The newly created private service.
 76        """
 77        return await self._http.request(
 78            "/api/v1/private_services",
 79            method="POST",
 80            body=input,
 81            response_type=PrivateService,
 82        )
 83
 84    async def get(self, private_service_id: str, *, org: str | None = None) -> PrivateService:
 85        """
 86        Retrieve a private service
 87
 88        Args:
 89            org: Organization ID or slug. Required for developer and server callers.
 90
 91        Returns:
 92            Successful response
 93        """
 94        query: dict[str, object] = {}
 95        if org is not None:
 96            query["org"] = org
 97        return await self._http.request(
 98            f"/api/v1/private_services/{private_service_id}",
 99            query=query,
100            response_type=PrivateService,
101        )
102
103
104class PrivateServiceResource:
105    def __init__(self, http: SyncHttpClient):
106        self._http = http
107
108    def list(
109        self, *, org: str | None = None, page: int | None = None, page_size: int | None = None
110    ) -> PrivateServicePage:
111        """
112        List private services
113
114        Args:
115            org: Organization ID or slug. Required for developer and server callers.
116            page: Page number. Defaults to 1.
117            page_size: Results per page. Defaults to 25; maximum is 100.
118
119        Returns:
120            Successful response
121        """
122        query: dict[str, object] = {}
123        if org is not None:
124            query["org"] = org
125        if page is not None:
126            query["page"] = page
127        if page_size is not None:
128            query["page_size"] = page_size
129        return self._http.request(
130            "/api/v1/private_services",
131            query=query,
132            response_type=PrivateServicePage,
133        )
134
135    def create(self, input: PrivateServiceCreateInput) -> PrivateService:
136        """
137        Create a private service
138        Creates one immutable private service in the selected organization.
139
140        Args:
141            input: Request body.
142            input.functions: Complete callable contracts. Input schemas are required; output schemas are optional.
143            input.org: Organization ID or slug. Required for developer and server callers.
144
145        Returns:
146            The newly created private service.
147        """
148        return self._http.request(
149            "/api/v1/private_services",
150            method="POST",
151            body=input,
152            response_type=PrivateService,
153        )
154
155    def get(self, private_service_id: str, *, org: str | None = None) -> PrivateService:
156        """
157        Retrieve a private service
158
159        Args:
160            org: Organization ID or slug. Required for developer and server callers.
161
162        Returns:
163            Successful response
164        """
165        query: dict[str, object] = {}
166        if org is not None:
167            query["org"] = org
168        return self._http.request(
169            f"/api/v1/private_services/{private_service_id}",
170            query=query,
171            response_type=PrivateService,
172        )
class PrivateServiceCreateInputFunctionsItem(typing.TypedDict):
14class PrivateServiceCreateInputFunctionsItem(TypedDict, total=False):
15    description: Required[str]
16    "Human-readable guidance describing when and why to call the operation."
17    input_schema: Required[dict[str, Any]]
18    "JSON Schema Draft 7 object describing the operation's argument object."
19    name: Required[str]
20    "Stable operation name used when invoking the private service."
21    output_schema: dict[str, Any] | None
22    "Optional JSON Schema Draft 7 object describing the successful result."
description: Required[str]

Human-readable guidance describing when and why to call the operation.

input_schema: Required[dict[str, Any]]

JSON Schema Draft 7 object describing the operation's argument object.

name: Required[str]

Stable operation name used when invoking the private service.

output_schema: dict[str, typing.Any] | None

Optional JSON Schema Draft 7 object describing the successful result.

class PrivateServiceCreateInput(typing.TypedDict):
25class PrivateServiceCreateInput(TypedDict, total=False):
26    "Create a private service"
27
28    functions: Required[list[PrivateServiceCreateInputFunctionsItem]]
29    "Complete callable contracts. Input schemas are required; output schemas are optional."
30    org: str | None
31    "Organization ID or slug. Required for developer and server callers."

Create a private service

functions: Required[list[PrivateServiceCreateInputFunctionsItem]]

Complete callable contracts. Input schemas are required; output schemas are optional.

org: str | None

Organization ID or slug. Required for developer and server callers.

class AsyncPrivateServiceResource:
 34class AsyncPrivateServiceResource:
 35    def __init__(self, http: HttpClient):
 36        self._http = http
 37
 38    async def list(
 39        self, *, org: str | None = None, page: int | None = None, page_size: int | None = None
 40    ) -> PrivateServicePage:
 41        """
 42        List private services
 43
 44        Args:
 45            org: Organization ID or slug. Required for developer and server callers.
 46            page: Page number. Defaults to 1.
 47            page_size: Results per page. Defaults to 25; maximum is 100.
 48
 49        Returns:
 50            Successful response
 51        """
 52        query: dict[str, object] = {}
 53        if org is not None:
 54            query["org"] = org
 55        if page is not None:
 56            query["page"] = page
 57        if page_size is not None:
 58            query["page_size"] = page_size
 59        return await self._http.request(
 60            "/api/v1/private_services",
 61            query=query,
 62            response_type=PrivateServicePage,
 63        )
 64
 65    async def create(self, input: PrivateServiceCreateInput) -> PrivateService:
 66        """
 67        Create a private service
 68        Creates one immutable private service in the selected organization.
 69
 70        Args:
 71            input: Request body.
 72            input.functions: Complete callable contracts. Input schemas are required; output schemas are optional.
 73            input.org: Organization ID or slug. Required for developer and server callers.
 74
 75        Returns:
 76            The newly created private service.
 77        """
 78        return await self._http.request(
 79            "/api/v1/private_services",
 80            method="POST",
 81            body=input,
 82            response_type=PrivateService,
 83        )
 84
 85    async def get(self, private_service_id: str, *, org: str | None = None) -> PrivateService:
 86        """
 87        Retrieve a private service
 88
 89        Args:
 90            org: Organization ID or slug. Required for developer and server callers.
 91
 92        Returns:
 93            Successful response
 94        """
 95        query: dict[str, object] = {}
 96        if org is not None:
 97            query["org"] = org
 98        return await self._http.request(
 99            f"/api/v1/private_services/{private_service_id}",
100            query=query,
101            response_type=PrivateService,
102        )
AsyncPrivateServiceResource(http: archastro.platform.runtime.http_client.HttpClient)
35    def __init__(self, http: HttpClient):
36        self._http = http
async def list( self, *, org: str | None = None, page: int | None = None, page_size: int | None = None) -> archastro.platform.types.common.PrivateServicePage:
38    async def list(
39        self, *, org: str | None = None, page: int | None = None, page_size: int | None = None
40    ) -> PrivateServicePage:
41        """
42        List private services
43
44        Args:
45            org: Organization ID or slug. Required for developer and server callers.
46            page: Page number. Defaults to 1.
47            page_size: Results per page. Defaults to 25; maximum is 100.
48
49        Returns:
50            Successful response
51        """
52        query: dict[str, object] = {}
53        if org is not None:
54            query["org"] = org
55        if page is not None:
56            query["page"] = page
57        if page_size is not None:
58            query["page_size"] = page_size
59        return await self._http.request(
60            "/api/v1/private_services",
61            query=query,
62            response_type=PrivateServicePage,
63        )

List private services

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: PrivateServiceCreateInput) -> archastro.platform.types.common.PrivateService:
65    async def create(self, input: PrivateServiceCreateInput) -> PrivateService:
66        """
67        Create a private service
68        Creates one immutable private service in the selected organization.
69
70        Args:
71            input: Request body.
72            input.functions: Complete callable contracts. Input schemas are required; output schemas are optional.
73            input.org: Organization ID or slug. Required for developer and server callers.
74
75        Returns:
76            The newly created private service.
77        """
78        return await self._http.request(
79            "/api/v1/private_services",
80            method="POST",
81            body=input,
82            response_type=PrivateService,
83        )

Create a private service Creates one immutable private service in the selected organization.

Arguments:
  • input: Request body.
  • input.functions: Complete callable contracts. Input schemas are required; output schemas are optional.
  • input.org: Organization ID or slug. Required for developer and server callers.
Returns:

The newly created private service.

async def get( self, private_service_id: str, *, org: str | None = None) -> archastro.platform.types.common.PrivateService:
 85    async def get(self, private_service_id: str, *, org: str | None = None) -> PrivateService:
 86        """
 87        Retrieve a private service
 88
 89        Args:
 90            org: Organization ID or slug. Required for developer and server callers.
 91
 92        Returns:
 93            Successful response
 94        """
 95        query: dict[str, object] = {}
 96        if org is not None:
 97            query["org"] = org
 98        return await self._http.request(
 99            f"/api/v1/private_services/{private_service_id}",
100            query=query,
101            response_type=PrivateService,
102        )

Retrieve a private service

Arguments:
  • org: Organization ID or slug. Required for developer and server callers.
Returns:

Successful response

class PrivateServiceResource:
105class PrivateServiceResource:
106    def __init__(self, http: SyncHttpClient):
107        self._http = http
108
109    def list(
110        self, *, org: str | None = None, page: int | None = None, page_size: int | None = None
111    ) -> PrivateServicePage:
112        """
113        List private services
114
115        Args:
116            org: Organization ID or slug. Required for developer and server callers.
117            page: Page number. Defaults to 1.
118            page_size: Results per page. Defaults to 25; maximum is 100.
119
120        Returns:
121            Successful response
122        """
123        query: dict[str, object] = {}
124        if org is not None:
125            query["org"] = org
126        if page is not None:
127            query["page"] = page
128        if page_size is not None:
129            query["page_size"] = page_size
130        return self._http.request(
131            "/api/v1/private_services",
132            query=query,
133            response_type=PrivateServicePage,
134        )
135
136    def create(self, input: PrivateServiceCreateInput) -> PrivateService:
137        """
138        Create a private service
139        Creates one immutable private service in the selected organization.
140
141        Args:
142            input: Request body.
143            input.functions: Complete callable contracts. Input schemas are required; output schemas are optional.
144            input.org: Organization ID or slug. Required for developer and server callers.
145
146        Returns:
147            The newly created private service.
148        """
149        return self._http.request(
150            "/api/v1/private_services",
151            method="POST",
152            body=input,
153            response_type=PrivateService,
154        )
155
156    def get(self, private_service_id: str, *, org: str | None = None) -> PrivateService:
157        """
158        Retrieve a private service
159
160        Args:
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_services/{private_service_id}",
171            query=query,
172            response_type=PrivateService,
173        )
PrivateServiceResource(http: archastro.platform.runtime.http_client.SyncHttpClient)
106    def __init__(self, http: SyncHttpClient):
107        self._http = http
def list( self, *, org: str | None = None, page: int | None = None, page_size: int | None = None) -> archastro.platform.types.common.PrivateServicePage:
109    def list(
110        self, *, org: str | None = None, page: int | None = None, page_size: int | None = None
111    ) -> PrivateServicePage:
112        """
113        List private services
114
115        Args:
116            org: Organization ID or slug. Required for developer and server callers.
117            page: Page number. Defaults to 1.
118            page_size: Results per page. Defaults to 25; maximum is 100.
119
120        Returns:
121            Successful response
122        """
123        query: dict[str, object] = {}
124        if org is not None:
125            query["org"] = org
126        if page is not None:
127            query["page"] = page
128        if page_size is not None:
129            query["page_size"] = page_size
130        return self._http.request(
131            "/api/v1/private_services",
132            query=query,
133            response_type=PrivateServicePage,
134        )

List private services

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

136    def create(self, input: PrivateServiceCreateInput) -> PrivateService:
137        """
138        Create a private service
139        Creates one immutable private service in the selected organization.
140
141        Args:
142            input: Request body.
143            input.functions: Complete callable contracts. Input schemas are required; output schemas are optional.
144            input.org: Organization ID or slug. Required for developer and server callers.
145
146        Returns:
147            The newly created private service.
148        """
149        return self._http.request(
150            "/api/v1/private_services",
151            method="POST",
152            body=input,
153            response_type=PrivateService,
154        )

Create a private service Creates one immutable private service in the selected organization.

Arguments:
  • input: Request body.
  • input.functions: Complete callable contracts. Input schemas are required; output schemas are optional.
  • input.org: Organization ID or slug. Required for developer and server callers.
Returns:

The newly created private service.

def get( self, private_service_id: str, *, org: str | None = None) -> archastro.platform.types.common.PrivateService:
156    def get(self, private_service_id: str, *, org: str | None = None) -> PrivateService:
157        """
158        Retrieve a private service
159
160        Args:
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_services/{private_service_id}",
171            query=query,
172            response_type=PrivateService,
173        )

Retrieve a private service

Arguments:
  • org: Organization ID or slug. Required for developer and server callers.
Returns:

Successful response