Box Platform provides functionality to provide access to content stored within Box. It provides endpoints for basic manipulation of files and folders, management of users within an enterprise, as well as more complex topics such as legal holds and retention policies.
Package
octri_box_platform· Version1.0.0· 297 operations
# In the delivered checkout
gem build octri_box_platform.gemspec
gem install octri_box_platform-1.0.0.gem
# After this version is published
gem install octri_box_platform -v 1.0.0The example calls get_ai_agents (GET /ai_agents), a low-friction operation that requires no request arguments.
require "octri_box_platform"
config = OctriBoxPlatform::ClientConfig.new
config.base_url = "https://api.box.com/2.0"
auth = OctriBoxPlatform::ClientAuthConfig.new
auth.o_auth2security = OctriBoxPlatform::OAuth2Auth.new(access_token: ENV.fetch("API_TOKEN"))
config.auth = auth
client = OctriBoxPlatform::BoxPlatform.new(config)
result = client.a_istudio.get_ai_agents()
p resultKeep credentials outside source control. The quickstart reads them from the environment and the client applies them to every request.
| Scheme | ClientAuthConfig field | Sent as |
|---|---|---|
| OAuth2Security | o_auth2security |
OAuth 2 access token |
- Base URL:
https://api.box.com/2.0. - Transport: Net::HTTP.
- Timeout: 30,000 ms per attempt.
- Retries: up to 3 attempts for status codes
408,425,429,500,502,503,504, with 500–8,000 ms backoff. - Idempotency: disabled.
- Error telemetry is disabled by default, even when a reporting endpoint is baked into the build. Consumers must opt in explicitly.
- Telemetry PII filtering is enabled by default: common credentials and direct identifiers are recursively replaced with
[REDACTED]before reports are sent. Disable it only through the generated logging config'sfilterPii(or language-native equivalent) for a trusted private sink.
High-level operation methods return the typed response body directly. The low-level request layer returns an SdkResponse<T> envelope containing data, status, headers, request ID, latency, and attempt count.
All failure paths use a small, predictable hierarchy:
| Error | Meaning |
|---|---|
SdkValidationError |
A request argument failed an OpenAPI constraint before network I/O. |
SdkHttpError |
The server returned a non-2xx response. |
SdkNetworkError |
DNS, connection, TLS, or socket failure. |
SdkTimeoutError |
The configured per-attempt timeout elapsed. |
HTTP errors expose status_code, the response body and headers, plus request_id when the server supplies one. Preserve the request ID in support logs; it is the fastest way to correlate a failed SDK call with server-side traces.
- Operation implementations are grouped under
lib/octri_box_platform/methods/. - 310 component models are split by API domain under
lib/octri_box_platform/models/<domain>.rborlib/octri_box_platform/models/<tag path>/models.rb, loaded bylib/octri_box_platform/types.rb. - Component schemas can choose a nested model folder with
x-octri-sdk-tags: ["Billing/Invoices"]; the first tag owns the model and/creates nesting. sdk-manifest.jsonis the language-neutral public API index: operations, request/response modes, model properties, enum values, and generation settings.- Public barrel/module exports are the compatibility boundary. Import public model names from those exports; internal domain filenames may evolve without changing model names.
Generated SDK includes schema-derived, zero-dependency mock server and network contract suite. Node.js 20+ required. Contract probes use authored response examples only; schema-synthesized routes remain available to the local server.
./scripts/mock --port 4010 starts server. ./scripts/test runs the mock contract suite, then native SDK tests. A zero-authored-example contract run succeeds with an explicit zero-test
summary; mismatches in authored examples still fail.