qbraid_core.services.comms.CommsClient

class qbraid_core.services.comms.CommsClient(api_key=None, session=None)

Send owner updates and read replies using existing qBraid credentials.

The API resolves recipients from the authenticated account. This client never accepts a recipient address, Slack channel, or Slack credential.

Automatic transport retries are disabled because a send can succeed even when its response is lost. An injected session must be dedicated to this client: its retry policy is configured accordingly. Injected sessions stay open when the client closes; sessions created by this client are closed.

__init__(api_key=None, session=None)

Methods

__init__([api_key, session])
close()	Close the session if this client created it.
get_credits_balance()	Get the current user's credit balance for their organization.
get_slack_auth_url()	Return the URL the owner opens to authorize their Slack account.
read_slack(*[, after, cursor, limit])	Read one page of the owner's DM timeline, newest first.
running_in_lab()	Check if running in the qBraid Lab environment.
send_email(subject, body)	Email the owner's account address; return recipient and message ID.
send_slack(message)	Send a DM to the linked owner; return the API delivery receipt.
user_credits_value()	Get the current user's qBraid credits value.

Attributes

session

The QbraidSessionV1 used to make requests.