@abliteration/sdk 0.1.0 → 0.1.1

package/docs/IndicesApi.md

@@ -0,0 +1,153 @@
+# IndicesApi
+
+All URIs are relative to *https://abliteration.org*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**getIndex**](IndicesApi.md#getindex) | **GET** /api/v1/indices/{id} | One index with history |
+| [**listIndices**](IndicesApi.md#listindices) | **GET** /api/v1/indices | All four indices |
+
+
+
+## getIndex
+
+> GetIndex200Response getIndex(id)
+
+One index with history
+
+Cost: 10 credits. Only dai has a history series; the others return an empty array with history_available false.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  IndicesApi,
+} from '@abliteration/sdk';
+import type { GetIndexRequest } 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 IndicesApi(config);
+
+  const body = {
+    // 'dai' | 'DAI' | 'freedom-velocity' | 'FV' | 'freedom_velocity' | 'weaponization' | 'WEAP' | 'f2w-latency' | 'F2W' | 'f2w_latency' | Canonical id or one of the short aliases (DAI, FV, WEAP, F2W). Case-insensitive.
+    id: id_example,
+  } satisfies GetIndexRequest;
+
+  try {
+    const data = await api.getIndex(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `dai`, `DAI`, `freedom-velocity`, `FV`, `freedom_velocity`, `weaponization`, `WEAP`, `f2w-latency`, `F2W`, `f2w_latency` | Canonical id or one of the short aliases (DAI, FV, WEAP, F2W). Case-insensitive. | [Defaults to `undefined`] [Enum: dai, DAI, freedom-velocity, FV, freedom_velocity, weaponization, WEAP, f2w-latency, F2W, f2w_latency] |
+
+### Return type
+
+[**GetIndex200Response**](GetIndex200Response.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** | Index with its full series. |  -  |
+| **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)
+
+
+## listIndices
+
+> ListIndices200Response listIndices()
+
+All four indices
+
+Cost: 20 credits. Check the measured flag before treating a value as a finding.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  IndicesApi,
+} from '@abliteration/sdk';
+import type { ListIndicesRequest } 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 IndicesApi(config);
+
+  try {
+    const data = await api.listIndices();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ListIndices200Response**](ListIndices200Response.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** | Current values with recent DAI history. |  -  |
+| **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/ListAuthors200Response.md

@@ -0,0 +1,48 @@
+
+# ListAuthors200Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`data` | [Array<Author>](Author.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 { ListAuthors200Response } 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 ListAuthors200Response
+
+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 ListAuthors200Response
+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/ListDatasets200Response.md

@@ -0,0 +1,48 @@
+
+# ListDatasets200Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`data` | [Array<Dataset>](Dataset.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 { ListDatasets200Response } 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 ListDatasets200Response
+
+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 ListDatasets200Response
+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/ListIndices200Response.md

@@ -0,0 +1,48 @@
+
+# ListIndices200Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`data` | [Array<ModelIndex>](ModelIndex.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 { ListIndices200Response } 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 ListIndices200Response
+
+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 ListIndices200Response
+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/ListMethods200Response.md

@@ -0,0 +1,48 @@
+
+# ListMethods200Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`data` | [Array<Method>](Method.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 { ListMethods200Response } 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 ListMethods200Response
+
+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 ListMethods200Response
+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/ListModels200Response.md

@@ -0,0 +1,48 @@
+
+# ListModels200Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`data` | [Array<ModelSummary>](ModelSummary.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 { ListModels200Response } 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 ListModels200Response
+
+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 ListModels200Response
+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/ListTimeline200Response.md

@@ -0,0 +1,48 @@
+
+# ListTimeline200Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`data` | [Array<Event>](Event.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 { ListTimeline200Response } 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 ListTimeline200Response
+
+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 ListTimeline200Response
+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/Method.md

@@ -0,0 +1,44 @@
+
+# Method
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`label` | string
+`category` | string
+`wiki_slug` | string
+`model_count` | number
+`total_downloads` | number
+
+## Example
+
+```typescript
+import type { Method } from '@abliteration/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "label": null,
+  "category": null,
+  "wiki_slug": null,
+  "model_count": null,
+  "total_downloads": null,
+} satisfies Method
+
+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 Method
+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/MethodDetail.md

@@ -0,0 +1,50 @@
+
+# MethodDetail
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`label` | string
+`category` | string
+`wiki_slug` | string
+`model_count` | number
+`total_downloads` | number
+`wiki_url` | string
+`top_authors` | [Array<MethodDetailAllOfTopAuthors>](MethodDetailAllOfTopAuthors.md)
+`sample_models` | [Array<ModelSummary>](ModelSummary.md)
+
+## Example
+
+```typescript
+import type { MethodDetail } from '@abliteration/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "label": null,
+  "category": null,
+  "wiki_slug": null,
+  "model_count": null,
+  "total_downloads": null,
+  "wiki_url": null,
+  "top_authors": null,
+  "sample_models": null,
+} satisfies MethodDetail
+
+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 MethodDetail
+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/MethodDetailAllOfTopAuthors.md

@@ -0,0 +1,36 @@
+
+# MethodDetailAllOfTopAuthors
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`author` | string
+`count` | number
+
+## Example
+
+```typescript
+import type { MethodDetailAllOfTopAuthors } from '@abliteration/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "author": null,
+  "count": null,
+} satisfies MethodDetailAllOfTopAuthors
+
+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 MethodDetailAllOfTopAuthors
+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)
+
+