@gtmi/ramp-api-client 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 twilio.
+
+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

@@ -0,0 +1,59 @@
+# @gtmi/ramp-api-client
+
+Type-safe SDK for the **RAMP API server** (`apps/api`). Auto-generated from the
+app's committed OpenAPI spec with [`@hey-api/openapi-ts`](https://heyapi.dev),
+shipping tree-shakeable per-operation functions, request/response types, and
+runtime [zod](https://zod.dev) schemas.
+
+## Install
+
+```sh
+pnpm add @gtmi/ramp-api-client
+```
+
+## Usage
+
+```ts
+import { createRampApiClient, postConversations } from '@gtmi/ramp-api-client';
+
+const client = createRampApiClient({
+  baseUrl: process.env.RAMP_API_URL!,
+  getAuthToken: () => process.env.CR_SERVER_API_KEY!, // sent as `Authorization: Bearer …`
+});
+
+const { data, error } = await postConversations({
+  client,
+  body: { configurationId: 'cfg_123' },
+});
+```
+
+Every operation accepts the `client` returned by `createRampApiClient`. Without
+`getAuthToken`, no `Authorization` header is sent (use for public endpoints).
+
+### Runtime validation
+
+Generated zod schemas are exported under `schemas`:
+
+```ts
+import { schemas } from '@gtmi/ramp-api-client';
+
+schemas.zPostConversationsBody.parse(input);
+```
+
+## A note on response types
+
+Request inputs are fully typed and zod-validated. Response types are only as
+rich as the OpenAPI spec's response schemas, which are sparse today — many
+responses are loosely typed until handler `@response` JSDoc is enriched. As that
+JSDoc lands, regenerating this SDK upgrades the response types with no API
+change here.
+
+## Regenerating
+
+This package is generated from `apps/api/public/openapi.json`:
+
+```sh
+pnpm --filter @gtmi/ramp-api-client generate
+```
+
+`src/generated/` is committed and drift-checked in CI. Do not edit it by hand.