Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

Faximus SDK candidate

Version 0.1.0 release candidate. TypeScript supports Node 22; Python supports Python 3.11+. The exact versions exercised are recorded in candidate evidence. Registry namespace ownership and registry publication remain pending. The previously published rc.3 archives remain available unchanged; this rc.4 candidate requires its own qualification and direct archive download verification.

Default execution fails with test_mode_unavailable until an explicit test credential mode and fresh, exact schema106 native readiness input are supplied. This candidate includes generated fixture/scenario helpers; see docs/product/developer-sdk-native-test.md in the source repository. Controlled fixtures explicitly select execution="fixture" and a loopback receiver. Live customer use explicitly selects execution="live"; real fax sends and account usage apply. Historical sandbox/nonprod key labels do not prove test isolation.

Use prepared fax intents for exact idempotency key/body reuse and explicit acceptance reconciliation. Mutations are never automatically retried. Read retries, cursors and polling are bounded; cancellation and timeouts terminate work. Unknown, partial or unconfirmed delivery never triggers a resend. API keys cannot manage keys; session/provider operations fail locally.

Generated models describe the source OpenAPI and are accessible through the models export/subpackage. Generated API mappings are reference material; the thin wrapper is the supported safe transport. OAS 3.1 generator support is beta. Runtime schema validation remains authoritative; generated types alone do not prove endpoint parity.

Verify exact webhook raw bytes before parsing, require the signed payload eventId, compare an optional event-ID header with that signed ID, then atomically deduplicate with your durable event store before effects. A bounded current/retiring secret pair supports rotation; the verifier does not maintain a hidden in-memory production dedupe store.

Release ownership: Faximus LLC. Registry publication requires verified namespace ownership. Publication to the owned archive origin requires qualified artifacts and direct download verification. See the release policy/tooling in sdk/ for fail-closed publication and readback checks. Consumers should pin this prerelease; additive fields must be tolerated, unknown enums remain unconfirmed and breaking changes require a major version after 1.0. Deprecation must preserve the prior package for migration. Rollback pins the prior qualified package version; public versions are never overwritten or silently deleted.

Webhook timestamp digits are strictly ASCII; the signed eventId is a nonempty valid Unicode scalar string bounded to 128 UTF8 bytes. Native UUID event IDs retain their existing format.

SDK source license: MIT, Copyright (c) 2026 Faximus LLC. Preserve LICENSE and NOTICE when distributing.

Response resource policy: JSON/text SDK responses default to a 4 MiB byte cap, configurable with maxResponseBytes (TypeScript) or max_response_bytes (Python) from 1 byte through 16 MiB. Both count streamed bytes rather than trusting Content-Length, close/cancel the stream on errors, and retain uncertain acceptance for dispatched mutations. This cap covers metadata and public contract reads; retrieve large fax documents through their qualified short-lived access URLs separately. Node fetch counts decompressed response bytes. Python requests identity encoding and rejects other encodings to avoid unbounded decompression. Python connected header/body/chunk reads are interrupted at the absolute deadline or cancellation; OS DNS resolution and TCP connection establishment before socket registration are outside this interruption guarantee. The pinned urllib3 dialer can make sequential per-address TCP attempts, each using the connect timeout; their cumulative time can exceed max_elapsed. Neither max_elapsed nor cancellation promises a hard total-return deadline during those pre-registration phases. Custom injected transports must honor the supplied deadlines/abort signals; they are test seams, not a bypass of the production resource policy.

Native test candidate: use createTestDocument, completeTestDocument, prepareTestFax, submitTestFax, pollTestFax, and cancelTestFax (Python uses snake_case). The SDK sets X-Faximus-Mode: test, binds each idempotent mutation to operation/target/exact body, and denies live-shaped or non-synthetic responses. Readiness is a qualified native configuration input, not proof minted by this SDK. Previously published rc.3 archives remain unchanged.

Metadata

Release files for faximus-sdk 0.1.0rc4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distribution (wheel)

Table of built distributions (wheels) for faximus-sdk 0.1.0rc4
File Interpreter ABI Platform Actions
faximus_sdk-0.1.0rc4-py3-none-any.whl Python 3 none any Details for faximus_sdk-0.1.0rc4-py3-none-any.whl

Release files / faximus_sdk-0.1.0rc4-py3-none-any.whl

Download URL faximus_sdk-0.1.0rc4-py3-none-any.whl
Size 725.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
e12db30a3e0bf54fed773f6d5c8dec7b8700bdb54e7104f66e2afd8987d50761
BLAKE2b-256 checksum
How to use checksums
198f5dc507094bea4313c213f3b5c7888ef117439d8ea2659ea6cea914b44281
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via python-requests/2.34.2

Security for faximus-sdk 0.1.0rc4

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page