@crevio/sdk 0.1.0

package/docs/sdks/user/README.md

@@ -0,0 +1,149 @@
+# User
+(*user*)
+
+## Overview
+
+User account management
+
+### Available Operations
+
+* [get](#get) - Get current user information
+* [delete](#delete) - Delete current user account
+
+## get
+
+Returns the profile information of the authenticated user
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="getMe" method="get" path="/me" -->
+```typescript
+import { Crevio } from "@crevio/sdk";
+
+const crevio = new Crevio({
+  apiKeyAuth: process.env["CREVIO_API_KEY_AUTH"] ?? "",
+});
+
+async function run() {
+  const result = await crevio.user.get();
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CrevioCore } from "@crevio/sdk/core.js";
+import { userGet } from "@crevio/sdk/funcs/userGet.js";
+
+// Use `CrevioCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const crevio = new CrevioCore({
+  apiKeyAuth: process.env["CREVIO_API_KEY_AUTH"] ?? "",
+});
+
+async function run() {
+  const res = await userGet(crevio);
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("userGet failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[models.User](../../models/user.md)\>**
+
+### Errors
+
+| Error Type                | Status Code               | Content Type              |
+| ------------------------- | ------------------------- | ------------------------- |
+| errors.ErrorT             | 401                       | application/json          |
+| errors.CrevioDefaultError | 4XX, 5XX                  | \*/\*                     |
+
+## delete
+
+Permanently deletes the authenticated user account
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="delete" method="delete" path="/me" -->
+```typescript
+import { Crevio } from "@crevio/sdk";
+
+const crevio = new Crevio({
+  apiKeyAuth: process.env["CREVIO_API_KEY_AUTH"] ?? "",
+});
+
+async function run() {
+  const result = await crevio.user.delete();
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CrevioCore } from "@crevio/sdk/core.js";
+import { userDelete } from "@crevio/sdk/funcs/userDelete.js";
+
+// Use `CrevioCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const crevio = new CrevioCore({
+  apiKeyAuth: process.env["CREVIO_API_KEY_AUTH"] ?? "",
+});
+
+async function run() {
+  const res = await userDelete(crevio);
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("userDelete failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[operations.DeleteResponse](../../models/operations/deleteresponse.md)\>**
+
+### Errors
+
+| Error Type                | Status Code               | Content Type              |
+| ------------------------- | ------------------------- | ------------------------- |
+| errors.ErrorT             | 401                       | application/json          |
+| errors.CrevioDefaultError | 4XX, 5XX                  | \*/\*                     |

package/examples/README.md

@@ -0,0 +1,31 @@
+# @crevio/sdk Examples
+
+This directory contains example scripts demonstrating how to use the @crevio/sdk SDK.
+
+## Prerequisites
+
+- Node.js (v18 or higher)
+- npm
+
+## Setup
+
+1. Copy `.env.template` to `.env`:
+   ```bash
+   cp .env.template .env
+   ```
+
+2. Edit `.env` and add your actual credentials (API keys, tokens, etc.)
+
+## Running the Examples
+
+To run an example file from the examples directory:
+
+```bash
+npm run build && npx tsx example.ts
+```
+
+## Creating new examples
+
+Duplicate an existing example file, they won't be overwritten by the generation process.
+
+