@alter-ai/ramp 0.0.0-stage → 0.2.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Alter AI, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,46 @@
-# Temporary Holding Version
+# @alter-ai/ramp
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Install `npm install @alter-ai/sdk @alter-ai/ramp`.
+
+Construct `RampIntegration(app, { grantId })` with an Alter `App` client.
+All 271 operations use immutable contract `2026-10-27`.
+OAuth and managed-secret/API-key grants use the same binding and controls when
+the provider supports that credential type.
+Requests are authorized, validated, and routed by the backend. Await `call.wait()`
+to handle immediate results and approvals, then decode with `result.bodyJson()`.
+This distribution contains only this provider's native types and response schemas.
+
+[Public API reference](https://docs.alterauth.com/reference/managed-ramp-operations) includes every operation's input/output fields and both SDK examples.
+
+
+## Resume after a process restart
+
+Persist the pending call's `approvalId` (TypeScript) or `approval_id` (Python)
+in your durable job record. After restarting, construct a fresh provider client:
+
+```typescript
+const resumed = await provider.resume(savedApprovalId);
+const result = await resumed.wait();
+const body = result.bodyJson();
+```
+
+```python
+resumed = await provider.resume(saved_approval_id)
+result = await resumed.wait()
+body = result.body_json()
+```
+
+The backend supplies the stored provider, operation and immutable contract version.
+The provider package verifies provider/version and applies that operation's validator
+and fault handling. Mismatches raise `ManagedOperationError` with
+`managed_approval_contract_mismatch` or `managed_approval_operation_mismatch`.
+The ID yields a union of operation outputs; TypeScript callers can narrow the call
+by `resumed.operation`. No operation or version is accepted from the caller.
+
+Generic `app.integrations.resume(id)` preserves raw response access and exact-number
+decoding; use the provider package for its response validator. Both use the existing
+approval poll's `proxy:execute` or `approvals:read` permissions and app/agent isolation.
+Resume also works after execution while the result is retained. Denial, expiry,
+execution failure and result purging retain the existing approval errors. Resume
+never resubmits the request. Raw approvals or missing stored identities fail with
+`managed_approval_identity_unavailable`.