Struct Client 

pub struct Client { /* private fields */ }

Implementations

impl Client

pub async fn get_rate_limits_with_reset_credits( &self, ) -> Result<RateLimitsWithResetCredits>

pub async fn list_rate_limit_reset_credits( &self, ) -> Result<RateLimitResetCreditsDetails>

pub async fn consume_rate_limit_reset_credit( &self, redeem_request_id: &str, ) -> Result<ConsumeRateLimitResetCreditResponse>

pub async fn consume_rate_limit_reset_credit_by_id( &self, redeem_request_id: &str, credit_id: &str, ) -> Result<ConsumeRateLimitResetCreditResponse>

impl Client

pub fn new( base_url: impl Into<String>, http_client_factory: HttpClientFactory, ) -> Self

pub fn from_auth( base_url: impl Into<String>, auth: &CodexAuth, http_client_factory: HttpClientFactory, ) -> Self

pub fn with_auth_provider(self, auth: SharedAuthProvider) -> Self

pub fn with_user_agent(self, ua: impl Into<String>) -> Self

pub fn with_chatgpt_account_id(self, account_id: impl Into<String>) -> Self

pub fn with_fedramp_routing_header(self) -> Self

pub fn with_path_style(self, style: PathStyle) -> Self

pub async fn get_rate_limits(&self) -> Result<RateLimitSnapshot>

pub async fn get_rate_limits_many(&self) -> Result<Vec<RateLimitSnapshot>>

pub async fn get_accounts_check(&self) -> Result<AccountsCheckResponse>

pub async fn get_token_usage_profile(&self) -> Result<TokenUsageProfile>

pub async fn send_add_credits_nudge_email( &self, credit_type: AddCreditsNudgeCreditType, ) -> Result<(), RequestError>

pub async fn list_tasks( &self, limit: Option<i32>, task_filter: Option<&str>, environment_id: Option<&str>, cursor: Option<&str>, ) -> Result<PaginatedListTaskListItem>

pub async fn get_task_details( &self, task_id: &str, ) -> Result<CodeTaskDetailsResponse>

pub async fn get_task_details_with_body( &self, task_id: &str, ) -> Result<(CodeTaskDetailsResponse, String, String)>

pub async fn list_sibling_turns( &self, task_id: &str, turn_id: &str, ) -> Result<TurnAttemptsSiblingTurnsResponse>

pub async fn get_config_bundle( &self, ) -> Result<ConfigBundleResponse, RequestError>

Fetch the selected cloud-managed config bundle from codex-backend.

GET /api/codex/config/bundle (Codex API style) or GET /wham/config/bundle (ChatGPT backend-api style).

pub async fn get_user_settings( &self, ) -> Result<CodexUserSettingsResponse, RequestError>

Fetch authenticated Codex user settings from the active backend route.

Uses GET /api/codex/settings/user for Codex API hosts and GET /wham/settings/user for ChatGPT backend-api hosts.

pub async fn list_workspace_messages( &self, ) -> Result<CodexWorkspaceMessagesResponse, RequestError>

pub async fn create_task(&self, request_body: Value) -> Result<String>

Create a new task (user turn) by POSTing to the appropriate backend path based on path_style. Returns the created task id.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.