Skip to content

client.component.cli

Generated methods for the component.cli namespace. Sync owner: WarmHubClient.component.cli. Async owner: AsyncWarmHubClient.component.cli.

call(org_name: str, component_name: str, method: str, *, install_repo: str, args: JsonValue | Unset = UNSET, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET)

Dispatch a component-declared CLI method through the backend.

See AsyncGeneratedComponentCliRestMixin.call.

call(org_name: str, component_name: str, method: str, *, install_repo: str, args: JsonValue | Unset = UNSET, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET)

Dispatch a component-declared CLI method through the backend.

Returns the envelope, and an UPSTREAM failure does not raise: a non-2xx from the component service arrives as ok=False with its own status and body so a caller can print the component’s error payload. Only WarmHub-level failures raise.

The result type is ComponentRegistrySetupCallResult because the TypeScript declares ComponentRegistryCliCallResult as an alias of it — the same {ok, status, body?, warnings} envelope, deliberately not a second shape.