@abliteration/sdk 0.1.0 → 0.1.1

package/docs/DatasetsApi.md

@@ -0,0 +1,176 @@
+# DatasetsApi
+
+All URIs are relative to *https://abliteration.org*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**getDataset**](DatasetsApi.md#getdataset) | **GET** /api/v1/datasets/{id} | Get one dataset |
+| [**listDatasets**](DatasetsApi.md#listdatasets) | **GET** /api/v1/datasets | List datasets |
+
+
+
+## getDataset
+
+> GetDataset200Response getDataset(id)
+
+Get one dataset
+
+Cost: 1 credit. The passport is null for datasets that do not have one yet.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DatasetsApi,
+} from '@abliteration/sdk';
+import type { GetDatasetRequest } from '@abliteration/sdk';
+
+async function example() {
+  console.log("🚀 Testing @abliteration/sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new DatasetsApi(config);
+
+  const body = {
+    // string
+    id: mlabonne/orpo-dpo-mix-40k,
+  } satisfies GetDatasetRequest;
+
+  try {
+    const data = await api.getDataset(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**GetDataset200Response**](GetDataset200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Dataset with files and passport. |  -  |
+| **401** | Missing, unknown or revoked key. |  -  |
+| **402** | Not enough credits. Only possible while metering is enabled. |  -  |
+| **404** | No such entity. |  -  |
+| **429** | Per-key rate limit exceeded. Retry-After header is set. |  -  |
+| **503** | Catalog temporarily unreadable. Nothing was charged. |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## listDatasets
+
+> ListDatasets200Response listDatasets(category, author, license, sort, limit, offset)
+
+List datasets
+
+Cost: 5-15 credits, by rows returned.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DatasetsApi,
+} from '@abliteration/sdk';
+import type { ListDatasetsRequest } from '@abliteration/sdk';
+
+async function example() {
+  console.log("🚀 Testing @abliteration/sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new DatasetsApi(config);
+
+  const body = {
+    // string | Workflow stage, for example heal or extract. (optional)
+    category: category_example,
+    // string | Publisher handle, case-insensitive. (optional)
+    author: author_example,
+    // string | License string as published. (optional)
+    license: license_example,
+    // 'downloads' | '-downloads' | 'likes' | '-likes' | 'created' | '-created' | 'created_at' | '-created_at' | 'first_seen' | '-first_seen' | 'first_seen_at' | '-first_seen_at' | Bare key is the natural direction (downloads/likes = most first, dates = newest first). A leading `-` flips it. `created` and `first_seen` are aliases for the full column names. (optional)
+    sort: sort_example,
+    // number | Rows to return, 1 to 1000. Values outside the range are clamped, not rejected. (optional)
+    limit: 56,
+    // number | Rows to skip. Negative and non-numeric values are treated as 0. (optional)
+    offset: 56,
+  } satisfies ListDatasetsRequest;
+
+  try {
+    const data = await api.listDatasets(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **category** | `string` | Workflow stage, for example heal or extract. | [Optional] [Defaults to `undefined`] |
+| **author** | `string` | Publisher handle, case-insensitive. | [Optional] [Defaults to `undefined`] |
+| **license** | `string` | License string as published. | [Optional] [Defaults to `undefined`] |
+| **sort** | `downloads`, `-downloads`, `likes`, `-likes`, `created`, `-created`, `created_at`, `-created_at`, `first_seen`, `-first_seen`, `first_seen_at`, `-first_seen_at` | Bare key is the natural direction (downloads/likes = most first, dates = newest first). A leading `-` flips it. `created` and `first_seen` are aliases for the full column names. | [Optional] [Defaults to `'downloads'`] [Enum: downloads, -downloads, likes, -likes, created, -created, created_at, -created_at, first_seen, -first_seen, first_seen_at, -first_seen_at] |
+| **limit** | `number` | Rows to return, 1 to 1000. Values outside the range are clamped, not rejected. | [Optional] [Defaults to `50`] |
+| **offset** | `number` | Rows to skip. Negative and non-numeric values are treated as 0. | [Optional] [Defaults to `0`] |
+
+### Return type
+
+[**ListDatasets200Response**](ListDatasets200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Matching datasets. |  -  |
+| **401** | Missing, unknown or revoked key. |  -  |
+| **402** | Not enough credits. Only possible while metering is enabled. |  -  |
+| **429** | Per-key rate limit exceeded. Retry-After header is set. |  -  |
+| **503** | Catalog temporarily unreadable. Nothing was charged. |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+

package/docs/Envelope.md

@@ -0,0 +1,48 @@
+
+# Envelope
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`data` | any
+`cost` | number
+`credits_remaining` | number
+`rate_limit_limit` | number
+`rate_limit_remaining` | number
+`rate_limit_reset` | number
+`metering` | string
+`request_id` | string
+
+## Example
+
+```typescript
+import type { Envelope } from '@abliteration/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "data": null,
+  "cost": null,
+  "credits_remaining": null,
+  "rate_limit_limit": null,
+  "rate_limit_remaining": null,
+  "rate_limit_reset": null,
+  "metering": null,
+  "request_id": null,
+} satisfies Envelope
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as Envelope
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/Event.md

@@ -0,0 +1,46 @@
+
+# Event
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`date` | string
+`date_precision` | string
+`type` | string
+`title` | string
+`description` | string
+`primary_source_url` | string
+
+## Example
+
+```typescript
+import type { Event } from '@abliteration/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "date": null,
+  "date_precision": null,
+  "type": null,
+  "title": null,
+  "description": null,
+  "primary_source_url": null,
+} satisfies Event
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as Event
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/GetAuthor200Response.md

@@ -0,0 +1,48 @@
+
+# GetAuthor200Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`data` | [AuthorDetail](AuthorDetail.md)
+`cost` | number
+`credits_remaining` | number
+`rate_limit_limit` | number
+`rate_limit_remaining` | number
+`rate_limit_reset` | number
+`metering` | string
+`request_id` | string
+
+## Example
+
+```typescript
+import type { GetAuthor200Response } from '@abliteration/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "data": null,
+  "cost": null,
+  "credits_remaining": null,
+  "rate_limit_limit": null,
+  "rate_limit_remaining": null,
+  "rate_limit_reset": null,
+  "metering": null,
+  "request_id": null,
+} satisfies GetAuthor200Response
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as GetAuthor200Response
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/GetDataset200Response.md

@@ -0,0 +1,48 @@
+
+# GetDataset200Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`data` | [DatasetDetail](DatasetDetail.md)
+`cost` | number
+`credits_remaining` | number
+`rate_limit_limit` | number
+`rate_limit_remaining` | number
+`rate_limit_reset` | number
+`metering` | string
+`request_id` | string
+
+## Example
+
+```typescript
+import type { GetDataset200Response } from '@abliteration/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "data": null,
+  "cost": null,
+  "credits_remaining": null,
+  "rate_limit_limit": null,
+  "rate_limit_remaining": null,
+  "rate_limit_reset": null,
+  "metering": null,
+  "request_id": null,
+} satisfies GetDataset200Response
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as GetDataset200Response
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/GetIndex200Response.md

@@ -0,0 +1,48 @@
+
+# GetIndex200Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`data` | [IndexDetail](IndexDetail.md)
+`cost` | number
+`credits_remaining` | number
+`rate_limit_limit` | number
+`rate_limit_remaining` | number
+`rate_limit_reset` | number
+`metering` | string
+`request_id` | string
+
+## Example
+
+```typescript
+import type { GetIndex200Response } from '@abliteration/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "data": null,
+  "cost": null,
+  "credits_remaining": null,
+  "rate_limit_limit": null,
+  "rate_limit_remaining": null,
+  "rate_limit_reset": null,
+  "metering": null,
+  "request_id": null,
+} satisfies GetIndex200Response
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as GetIndex200Response
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/GetMethod200Response.md

@@ -0,0 +1,48 @@
+
+# GetMethod200Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`data` | [MethodDetail](MethodDetail.md)
+`cost` | number
+`credits_remaining` | number
+`rate_limit_limit` | number
+`rate_limit_remaining` | number
+`rate_limit_reset` | number
+`metering` | string
+`request_id` | string
+
+## Example
+
+```typescript
+import type { GetMethod200Response } from '@abliteration/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "data": null,
+  "cost": null,
+  "credits_remaining": null,
+  "rate_limit_limit": null,
+  "rate_limit_remaining": null,
+  "rate_limit_reset": null,
+  "metering": null,
+  "request_id": null,
+} satisfies GetMethod200Response
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as GetMethod200Response
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/GetModel200Response.md

@@ -0,0 +1,48 @@
+
+# GetModel200Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`data` | [ModelDetail](ModelDetail.md)
+`cost` | number
+`credits_remaining` | number
+`rate_limit_limit` | number
+`rate_limit_remaining` | number
+`rate_limit_reset` | number
+`metering` | string
+`request_id` | string
+
+## Example
+
+```typescript
+import type { GetModel200Response } from '@abliteration/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "data": null,
+  "cost": null,
+  "credits_remaining": null,
+  "rate_limit_limit": null,
+  "rate_limit_remaining": null,
+  "rate_limit_reset": null,
+  "metering": null,
+  "request_id": null,
+} satisfies GetModel200Response
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as GetModel200Response
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/IndexDetail.md

@@ -0,0 +1,54 @@
+
+# IndexDetail
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`name` | string
+`value` | number
+`unit` | string
+`measured` | boolean
+`source` | string
+`history_available` | boolean
+`as_of` | string
+`note` | string
+`recent_history` | [Array<DaiPoint>](DaiPoint.md)
+`history` | [Array<DaiPoint>](DaiPoint.md)
+
+## Example
+
+```typescript
+import type { IndexDetail } from '@abliteration/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "name": null,
+  "value": null,
+  "unit": null,
+  "measured": null,
+  "source": null,
+  "history_available": null,
+  "as_of": null,
+  "note": null,
+  "recent_history": null,
+  "history": null,
+} satisfies IndexDetail
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as IndexDetail
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+