codecraftai-restclient-pychestrate 1.2.0__py3-none-any.whl

ccai/pychestrate/rest/client/groups/clients.py

@@ -0,0 +1,287 @@
+# Auto-generated by RestClientGenerator. DO NOT EDIT.
+
+from typing import Any, Dict, List, Optional
+
+from ccai.pychestrate.rest.client.models.client import Client
+from ccai.pychestrate.rest.client.models.clients import Clientattributesupdaterequest
+from ccai.pychestrate.rest.client.models.clients import Clientrevokerequest
+from ccai.pychestrate.rest.client.models.clients import Pendingdispatch
+from ccai.restclient.base.aspectsrest import AspectsRest
+from ccai.restclient.base.restapigroup import RestApiGroup
+
+
+class ClientsApiGroup(RestApiGroup):
+    """
+        Registered pod client agents.
+    """
+
+    def clients_dispatches_next(self, client_id: str, *, timeout_seconds: Optional[int] = 30, exp_status: Optional[List[int]] = None, headers: Optional[Dict[str, str]] = None, aspects: Optional[AspectsRest] = None) -> Pendingdispatch:
+        """
+            Long-poll for the next signed dispatch envelope.
+            
+            Long-polling pull endpoint the pod-client calls to fetch
+the next signed envelope queued for it by the server
+dispatcher.
+
+The server blocks the request for up to `timeout_seconds`
+(default 30, hard cap 60). On a queued dispatch the server
+returns 200 with a `PendingDispatch` body and the record
+is dequeued — the client MUST then POST
+`/runs/{run_id}/dispatch-ack` before the embedded
+`ack_deadline_at`, otherwise the dispatch reconciler will
+roll the attempt back. On a timeout the server returns 204
+and the client immediately re-polls.
+
+The cert common-name nginx forwards must match the path
+`client_id` — a mismatch returns 403.
+
+        """
+        client = self.client
+        if aspects is None:
+            aspects = client.aspects
+
+        header_params = client.headers
+        if headers is not None:
+            header_params = headers
+
+        leaf_template = "/clients/{client_id}/dispatches:next"
+        path_params = {
+            'client_id': client_id,
+        }
+        call_leaf = leaf_template.format(**path_params)
+
+        query_params = {}
+        if timeout_seconds is not None:
+            query_params['timeout_seconds'] = timeout_seconds
+
+
+        if exp_status is None:
+            exp_status = [200, 204]
+
+        resp = client.perform_call(
+            leaf=call_leaf,
+            method="GET",
+            params=query_params if query_params else None,
+            body=None,
+            exp_status=exp_status,
+            headers=header_params if header_params else None,
+            context_msg=None,
+            aspects=aspects,
+        )
+        if resp.status_code in (204, 205) or (resp.status_code == 202 and len(resp.content) == 0):
+            rtnobj = None
+        else:
+            raw_data = resp.json()
+            rtnobj = Pendingdispatch.from_dict(raw_data)
+        return rtnobj
+
+    def clients_get_by_id(self, client_id: str, *, exp_status: Optional[List[int]] = None, headers: Optional[Dict[str, str]] = None, aspects: Optional[AspectsRest] = None) -> Client:
+        """
+            Read a client.
+        """
+        client = self.client
+        if aspects is None:
+            aspects = client.aspects
+
+        header_params = client.headers
+        if headers is not None:
+            header_params = headers
+
+        leaf_template = "/clients/{client_id}"
+        path_params = {
+            'client_id': client_id,
+        }
+        call_leaf = leaf_template.format(**path_params)
+
+        query_params = None
+
+
+        if exp_status is None:
+            exp_status = [200]
+
+        resp = client.perform_call(
+            leaf=call_leaf,
+            method="GET",
+            params=query_params if query_params else None,
+            body=None,
+            exp_status=exp_status,
+            headers=header_params if header_params else None,
+            context_msg=None,
+            aspects=aspects,
+        )
+        if resp.status_code in (204, 205) or (resp.status_code == 202 and len(resp.content) == 0):
+            rtnobj = None
+        else:
+            raw_data = resp.json()
+            rtnobj = Client.from_dict(raw_data)
+        return rtnobj
+
+    def clients_heartbeat(self, client_id: str, *, exp_status: Optional[List[int]] = None, headers: Optional[Dict[str, str]] = None, aspects: Optional[AspectsRest] = None) -> Any:
+        """
+            Pod-client liveness ping.
+            
+            Lightweight ping the pod-client calls between long-poll
+cycles to keep its registry row `last_seen` current.
+Returns 204 unconditionally on a successful mTLS
+handshake; rows missing from the registry are logged
+server-side and still answered 204.
+
+        """
+        client = self.client
+        if aspects is None:
+            aspects = client.aspects
+
+        header_params = client.headers
+        if headers is not None:
+            header_params = headers
+
+        leaf_template = "/clients/{client_id}/heartbeat"
+        path_params = {
+            'client_id': client_id,
+        }
+        call_leaf = leaf_template.format(**path_params)
+
+        query_params = None
+
+
+        if exp_status is None:
+            exp_status = [204]
+
+        resp = client.perform_call(
+            leaf=call_leaf,
+            method="GET",
+            params=query_params if query_params else None,
+            body=None,
+            exp_status=exp_status,
+            headers=header_params if header_params else None,
+            context_msg=None,
+            aspects=aspects,
+        )
+        if resp.status_code in (204, 205) or (resp.status_code == 202 and len(resp.content) == 0):
+            rtnval = None
+        else:
+            rtnval = resp.json()
+        return rtnval
+
+    def clients_list(self, *, page: Optional[int] = 1, per_page: Optional[int] = 50, exp_status: Optional[List[int]] = None, headers: Optional[Dict[str, str]] = None, aspects: Optional[AspectsRest] = None) -> Dict[str, Any]:
+        """
+            List enrolled clients.
+        """
+        client = self.client
+        if aspects is None:
+            aspects = client.aspects
+
+        header_params = client.headers
+        if headers is not None:
+            header_params = headers
+
+        call_leaf = "/clients"
+
+        query_params = {}
+        if page is not None:
+            query_params['page'] = page
+        if per_page is not None:
+            query_params['per_page'] = per_page
+
+
+        if exp_status is None:
+            exp_status = [200]
+
+        resp = client.perform_call(
+            leaf=call_leaf,
+            method="GET",
+            params=query_params if query_params else None,
+            body=None,
+            exp_status=exp_status,
+            headers=header_params if header_params else None,
+            context_msg=None,
+            aspects=aspects,
+        )
+        if resp.status_code in (204, 205) or (resp.status_code == 202 and len(resp.content) == 0):
+            rtnval = None
+        else:
+            raw_data = resp.json()
+            rtnval = self._parse_item(raw_data, Dict[str, Any])
+        return rtnval
+
+    def clients_revoke(self, client_id: str, body: Clientrevokerequest, *, exp_status: Optional[List[int]] = None, headers: Optional[Dict[str, str]] = None, aspects: Optional[AspectsRest] = None) -> Client:
+        """
+            Revoke a client's enrollment.
+        """
+        client = self.client
+        if aspects is None:
+            aspects = client.aspects
+
+        header_params = client.headers
+        if headers is not None:
+            header_params = headers
+
+        leaf_template = "/clients/{client_id}/revoke"
+        path_params = {
+            'client_id': client_id,
+        }
+        call_leaf = leaf_template.format(**path_params)
+
+        query_params = None
+
+
+        if exp_status is None:
+            exp_status = [200]
+
+        resp = client.perform_call(
+            leaf=call_leaf,
+            method="POST",
+            params=query_params if query_params else None,
+            body=body,
+            exp_status=exp_status,
+            headers=header_params if header_params else None,
+            context_msg=None,
+            aspects=aspects,
+        )
+        if resp.status_code in (204, 205) or (resp.status_code == 202 and len(resp.content) == 0):
+            rtnobj = None
+        else:
+            raw_data = resp.json()
+            rtnobj = Client.from_dict(raw_data)
+        return rtnobj
+
+    def clients_update_attributes(self, client_id: str, body: Clientattributesupdaterequest, *, exp_status: Optional[List[int]] = None, headers: Optional[Dict[str, str]] = None, aspects: Optional[AspectsRest] = None) -> Client:
+        """
+            Replace a client's attributes.
+        """
+        client = self.client
+        if aspects is None:
+            aspects = client.aspects
+
+        header_params = client.headers
+        if headers is not None:
+            header_params = headers
+
+        leaf_template = "/clients/{client_id}/attributes"
+        path_params = {
+            'client_id': client_id,
+        }
+        call_leaf = leaf_template.format(**path_params)
+
+        query_params = None
+
+
+        if exp_status is None:
+            exp_status = [200]
+
+        resp = client.perform_call(
+            leaf=call_leaf,
+            method="PUT",
+            params=query_params if query_params else None,
+            body=body,
+            exp_status=exp_status,
+            headers=header_params if header_params else None,
+            context_msg=None,
+            aspects=aspects,
+        )
+        if resp.status_code in (204, 205) or (resp.status_code == 202 and len(resp.content) == 0):
+            rtnobj = None
+        else:
+            raw_data = resp.json()
+            rtnobj = Client.from_dict(raw_data)
+        return rtnobj

ccai/pychestrate/rest/client/groups/dispatch.py

@@ -0,0 +1,118 @@
+# Auto-generated by RestClientGenerator. DO NOT EDIT.
+
+from typing import Any, Dict, List, Optional
+
+from ccai.pychestrate.rest.client.models.dispatch import Dispatchack
+from ccai.pychestrate.rest.client.models.dispatch import Signingkeyset
+from ccai.restclient.base.aspectsrest import AspectsRest
+from ccai.restclient.base.restapigroup import RestApiGroup
+
+
+class DispatchApiGroup(RestApiGroup):
+    """
+        Pod-client → server dispatch acknowledgements.
+    """
+
+    def dispatch_ack_run(self, run_id: str, body: Dispatchack, *, exp_status: Optional[List[int]] = None, headers: Optional[Dict[str, str]] = None, aspects: Optional[AspectsRest] = None) -> Any:
+        """
+            Client agent acknowledges receipt of a dispatched envelope.
+            
+            Posted by the pod client agent over mTLS after it has accepted
+a dispatch and minted a local run identifier. Signals that the
+envelope was received and is being prepared for execution; the
+server transitions the run's state from `DISPATCHING` to
+`DISPATCHED` on success.
+
+        """
+        client = self.client
+        if aspects is None:
+            aspects = client.aspects
+
+        header_params = client.headers
+        if headers is not None:
+            header_params = headers
+
+        leaf_template = "/runs/{run_id}/dispatch-ack"
+        path_params = {
+            'run_id': run_id,
+        }
+        call_leaf = leaf_template.format(**path_params)
+
+        query_params = None
+
+
+        if exp_status is None:
+            exp_status = [204]
+
+        resp = client.perform_call(
+            leaf=call_leaf,
+            method="POST",
+            params=query_params if query_params else None,
+            body=body,
+            exp_status=exp_status,
+            headers=header_params if header_params else None,
+            context_msg=None,
+            aspects=aspects,
+        )
+        if resp.status_code in (204, 205) or (resp.status_code == 202 and len(resp.content) == 0):
+            rtnval = None
+        else:
+            rtnval = resp.json()
+        return rtnval
+
+    def envelope_signing_keys_list(self, *, exp_status: Optional[List[int]] = None, headers: Optional[Dict[str, str]] = None, aspects: Optional[AspectsRest] = None) -> Signingkeyset:
+        """
+            List the Ed25519 public keys used to sign job envelopes.
+            
+            A JWKS-style public-key distribution endpoint. The pod-client
+agent calls this to obtain the Ed25519 public key(s) it must
+verify signed job envelopes against — without the operator
+installing the key out-of-band.
+
+Auth: a signing *public* key is not a secret, so the endpoint
+accepts **any authenticated principal** — a cookie session, an
+API key, OR a verified mTLS client certificate. A
+freshly-enrolled pod client already holds its mTLS identity, so
+the mTLS path covers the client's use case. Anonymous requests
+get a 401. The endpoint returns 503 when no signing key has
+been provisioned.
+
+The response carries one or more keys to support rotation: at
+most one key is `active` and any others are `retiring`
+(grace-window verify keys). The same key set is also bundled in
+the `POST /enrollment-tokens/redeem` response so the happy path
+needs zero extra calls.
+
+        """
+        client = self.client
+        if aspects is None:
+            aspects = client.aspects
+
+        header_params = client.headers
+        if headers is not None:
+            header_params = headers
+
+        call_leaf = "/envelope-signing-keys"
+
+        query_params = None
+
+
+        if exp_status is None:
+            exp_status = [200]
+
+        resp = client.perform_call(
+            leaf=call_leaf,
+            method="GET",
+            params=query_params if query_params else None,
+            body=None,
+            exp_status=exp_status,
+            headers=header_params if header_params else None,
+            context_msg=None,
+            aspects=aspects,
+        )
+        if resp.status_code in (204, 205) or (resp.status_code == 202 and len(resp.content) == 0):
+            rtnobj = None
+        else:
+            raw_data = resp.json()
+            rtnobj = Signingkeyset.from_dict(raw_data)
+        return rtnobj

ccai/pychestrate/rest/client/groups/enrollment.py

@@ -0,0 +1,212 @@
+# Auto-generated by RestClientGenerator. DO NOT EDIT.
+
+from typing import Any, Dict, List, Optional
+
+from ccai.pychestrate.rest.client.models.client import Client
+from ccai.pychestrate.rest.client.models.enrollment import Enrollmentredeemrequest
+from ccai.pychestrate.rest.client.models.enrollment import Enrollmentredeemresponse
+from ccai.pychestrate.rest.client.models.enrollment import Enrollmenttokencreaterequest
+from ccai.restclient.base.aspectsrest import AspectsRest
+from ccai.restclient.base.restapigroup import RestApiGroup
+
+
+class EnrollmentApiGroup(RestApiGroup):
+    """
+        Client-enrollment bootstrap tokens (mTLS issuance).
+    """
+
+    def enrollment_create_token(self, body: Enrollmenttokencreaterequest, *, exp_status: Optional[List[int]] = None, headers: Optional[Dict[str, str]] = None, aspects: Optional[AspectsRest] = None) -> Any:
+        """
+            Issue a new enrollment token.
+        """
+        client = self.client
+        if aspects is None:
+            aspects = client.aspects
+
+        header_params = client.headers
+        if headers is not None:
+            header_params = headers
+
+        call_leaf = "/enrollment-tokens"
+
+        query_params = None
+
+
+        if exp_status is None:
+            exp_status = [201]
+
+        resp = client.perform_call(
+            leaf=call_leaf,
+            method="POST",
+            params=query_params if query_params else None,
+            body=body,
+            exp_status=exp_status,
+            headers=header_params if header_params else None,
+            context_msg=None,
+            aspects=aspects,
+        )
+        if resp.status_code in (204, 205) or (resp.status_code == 202 and len(resp.content) == 0):
+            rtnval = None
+        else:
+            rtnval = resp.json()
+        return rtnval
+
+    def enrollment_delete_token(self, token_id: str, *, exp_status: Optional[List[int]] = None, headers: Optional[Dict[str, str]] = None, aspects: Optional[AspectsRest] = None) -> Any:
+        """
+            Revoke an enrollment token.
+        """
+        client = self.client
+        if aspects is None:
+            aspects = client.aspects
+
+        header_params = client.headers
+        if headers is not None:
+            header_params = headers
+
+        leaf_template = "/enrollment-tokens/{token_id}"
+        path_params = {
+            'token_id': token_id,
+        }
+        call_leaf = leaf_template.format(**path_params)
+
+        query_params = None
+
+
+        if exp_status is None:
+            exp_status = [204]
+
+        resp = client.perform_call(
+            leaf=call_leaf,
+            method="DELETE",
+            params=query_params if query_params else None,
+            body=None,
+            exp_status=exp_status,
+            headers=header_params if header_params else None,
+            context_msg=None,
+            aspects=aspects,
+        )
+        if resp.status_code in (204, 205) or (resp.status_code == 202 and len(resp.content) == 0):
+            rtnval = None
+        else:
+            rtnval = resp.json()
+        return rtnval
+
+    def enrollment_list_tokens(self, *, exp_status: Optional[List[int]] = None, headers: Optional[Dict[str, str]] = None, aspects: Optional[AspectsRest] = None) -> Dict[str, Any]:
+        """
+            List enrollment tokens.
+        """
+        client = self.client
+        if aspects is None:
+            aspects = client.aspects
+
+        header_params = client.headers
+        if headers is not None:
+            header_params = headers
+
+        call_leaf = "/enrollment-tokens"
+
+        query_params = None
+
+
+        if exp_status is None:
+            exp_status = [200]
+
+        resp = client.perform_call(
+            leaf=call_leaf,
+            method="GET",
+            params=query_params if query_params else None,
+            body=None,
+            exp_status=exp_status,
+            headers=header_params if header_params else None,
+            context_msg=None,
+            aspects=aspects,
+        )
+        if resp.status_code in (204, 205) or (resp.status_code == 202 and len(resp.content) == 0):
+            rtnval = None
+        else:
+            raw_data = resp.json()
+            rtnval = self._parse_item(raw_data, Dict[str, Any])
+        return rtnval
+
+    def enrollment_redeem(self, body: Enrollmentredeemrequest, *, exp_status: Optional[List[int]] = None, headers: Optional[Dict[str, str]] = None, aspects: Optional[AspectsRest] = None) -> Enrollmentredeemresponse:
+        """
+            Redeem an enrollment token for an mTLS identity.
+            
+            The client agent calls this endpoint with the bootstrap token it
+received out-of-band and a CSR; the response carries the signed
+client certificate plus the issued client_id.
+
+        """
+        client = self.client
+        if aspects is None:
+            aspects = client.aspects
+
+        header_params = client.headers
+        if headers is not None:
+            header_params = headers
+
+        call_leaf = "/enrollment-tokens/redeem"
+
+        query_params = None
+
+
+        if exp_status is None:
+            exp_status = [200]
+
+        resp = client.perform_call(
+            leaf=call_leaf,
+            method="POST",
+            params=query_params if query_params else None,
+            body=body,
+            exp_status=exp_status,
+            headers=header_params if header_params else None,
+            context_msg=None,
+            aspects=aspects,
+        )
+        if resp.status_code in (204, 205) or (resp.status_code == 202 and len(resp.content) == 0):
+            rtnobj = None
+        else:
+            raw_data = resp.json()
+            rtnobj = Enrollmentredeemresponse.from_dict(raw_data)
+        return rtnobj
+
+    def enrollment_revoke_client(self, client_id: str, *, exp_status: Optional[List[int]] = None, headers: Optional[Dict[str, str]] = None, aspects: Optional[AspectsRest] = None) -> Client:
+        """
+            Revoke an enrolled client's mTLS identity.
+        """
+        client = self.client
+        if aspects is None:
+            aspects = client.aspects
+
+        header_params = client.headers
+        if headers is not None:
+            header_params = headers
+
+        leaf_template = "/enrollment-tokens/clients/{client_id}/revoke"
+        path_params = {
+            'client_id': client_id,
+        }
+        call_leaf = leaf_template.format(**path_params)
+
+        query_params = None
+
+
+        if exp_status is None:
+            exp_status = [200]
+
+        resp = client.perform_call(
+            leaf=call_leaf,
+            method="POST",
+            params=query_params if query_params else None,
+            body=None,
+            exp_status=exp_status,
+            headers=header_params if header_params else None,
+            context_msg=None,
+            aspects=aspects,
+        )
+        if resp.status_code in (204, 205) or (resp.status_code == 202 and len(resp.content) == 0):
+            rtnobj = None
+        else:
+            raw_data = resp.json()
+            rtnobj = Client.from_dict(raw_data)
+        return rtnobj