@abliteration/sdk 0.1.0 → 0.1.2

package/src/apis/DatasetsApi.ts

@@ -0,0 +1,278 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * abliteration.org Public API
+ * Read access to the abliteration.org catalog: models and their method classification, alignment datasets and their passports, the M-code taxonomy, the four flagship indices and the curated field timeline.  Every call is authenticated with a bearer key and metered in credits against the same wallet the Research Agent spends from. There is no free tier for machine traffic and no separate billing.  Responses report `cost` and `credits_remaining` on every success. While `metering` reads `preview`, the cost shown is what the call will bill once metering is enabled and nothing is actually deducted; when it reads `billed`, it was.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import * as runtime from '../runtime';
+import {
+    type GetDataset200Response,
+    GetDataset200ResponseFromJSON,
+    GetDataset200ResponseToJSON,
+} from '../models/GetDataset200Response';
+import {
+    type ListDatasets200Response,
+    ListDatasets200ResponseFromJSON,
+    ListDatasets200ResponseToJSON,
+} from '../models/ListDatasets200Response';
+
+export interface GetDatasetRequest {
+    /**
+     * 
+     */
+    id: string;
+}
+
+export interface ListDatasetsRequest {
+    /**
+     * Workflow stage, for example heal or extract.
+     */
+    category?: string;
+    /**
+     * Publisher handle, case-insensitive.
+     */
+    author?: string;
+    /**
+     * License string as published.
+     */
+    license?: string;
+    /**
+     * 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.
+     */
+    sort?: ListDatasetsSortEnum;
+    /**
+     * Rows to return, 1 to 1000. Values outside the range are clamped, not rejected.
+     */
+    limit?: number;
+    /**
+     * Rows to skip. Negative and non-numeric values are treated as 0.
+     */
+    offset?: number;
+}
+
+/**
+ * DatasetsApi - interface
+ * 
+ * @export
+ * @interface DatasetsApiInterface
+ */
+export interface DatasetsApiInterface {
+    /**
+     * Creates request options for getDataset without sending the request
+     * @param {string} id 
+     * @throws {RequiredError}
+     * @memberof DatasetsApiInterface
+     */
+    getDatasetRequestOpts(requestParameters: GetDatasetRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * Cost: 1 credit. The passport is null for datasets that do not have one yet.
+     * @summary Get one dataset
+     * @param {string} id 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DatasetsApiInterface
+     */
+    getDatasetRaw(requestParameters: GetDatasetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetDataset200Response>>;
+
+    /**
+     * Cost: 1 credit. The passport is null for datasets that do not have one yet.
+     * Get one dataset
+     */
+    getDataset(requestParameters: GetDatasetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetDataset200Response>;
+
+    /**
+     * Creates request options for listDatasets without sending the request
+     * @param {string} [category] Workflow stage, for example heal or extract.
+     * @param {string} [author] Publisher handle, case-insensitive.
+     * @param {string} [license] License string as published.
+     * @param {'downloads' | '-downloads' | 'likes' | '-likes' | 'created' | '-created' | 'created_at' | '-created_at' | 'first_seen' | '-first_seen' | 'first_seen_at' | '-first_seen_at'} [sort] Bare key is the natural direction (downloads/likes &#x3D; most first, dates &#x3D; newest first). A leading &#x60;-&#x60; flips it. &#x60;created&#x60; and &#x60;first_seen&#x60; are aliases for the full column names.
+     * @param {number} [limit] Rows to return, 1 to 1000. Values outside the range are clamped, not rejected.
+     * @param {number} [offset] Rows to skip. Negative and non-numeric values are treated as 0.
+     * @throws {RequiredError}
+     * @memberof DatasetsApiInterface
+     */
+    listDatasetsRequestOpts(requestParameters: ListDatasetsRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * Cost: 5-15 credits, by rows returned.
+     * @summary List datasets
+     * @param {string} [category] Workflow stage, for example heal or extract.
+     * @param {string} [author] Publisher handle, case-insensitive.
+     * @param {string} [license] License string as published.
+     * @param {'downloads' | '-downloads' | 'likes' | '-likes' | 'created' | '-created' | 'created_at' | '-created_at' | 'first_seen' | '-first_seen' | 'first_seen_at' | '-first_seen_at'} [sort] Bare key is the natural direction (downloads/likes &#x3D; most first, dates &#x3D; newest first). A leading &#x60;-&#x60; flips it. &#x60;created&#x60; and &#x60;first_seen&#x60; are aliases for the full column names.
+     * @param {number} [limit] Rows to return, 1 to 1000. Values outside the range are clamped, not rejected.
+     * @param {number} [offset] Rows to skip. Negative and non-numeric values are treated as 0.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DatasetsApiInterface
+     */
+    listDatasetsRaw(requestParameters: ListDatasetsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListDatasets200Response>>;
+
+    /**
+     * Cost: 5-15 credits, by rows returned.
+     * List datasets
+     */
+    listDatasets(requestParameters: ListDatasetsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListDatasets200Response>;
+
+}
+
+/**
+ * 
+ */
+export class DatasetsApi extends runtime.BaseAPI implements DatasetsApiInterface {
+
+    /**
+     * Creates request options for getDataset without sending the request
+     */
+    async getDatasetRequestOpts(requestParameters: GetDatasetRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling getDataset().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearerAuth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/api/v1/datasets/{id}`;
+        urlPath = urlPath.replace('{id}', encodeURIComponent(String(requestParameters['id'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Cost: 1 credit. The passport is null for datasets that do not have one yet.
+     * Get one dataset
+     */
+    async getDatasetRaw(requestParameters: GetDatasetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetDataset200Response>> {
+        const requestOptions = await this.getDatasetRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetDataset200ResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Cost: 1 credit. The passport is null for datasets that do not have one yet.
+     * Get one dataset
+     */
+    async getDataset(requestParameters: GetDatasetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetDataset200Response> {
+        const response = await this.getDatasetRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for listDatasets without sending the request
+     */
+    async listDatasetsRequestOpts(requestParameters: ListDatasetsRequest): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        if (requestParameters['category'] != null) {
+            queryParameters['category'] = requestParameters['category'];
+        }
+
+        if (requestParameters['author'] != null) {
+            queryParameters['author'] = requestParameters['author'];
+        }
+
+        if (requestParameters['license'] != null) {
+            queryParameters['license'] = requestParameters['license'];
+        }
+
+        if (requestParameters['sort'] != null) {
+            queryParameters['sort'] = requestParameters['sort'];
+        }
+
+        if (requestParameters['limit'] != null) {
+            queryParameters['limit'] = requestParameters['limit'];
+        }
+
+        if (requestParameters['offset'] != null) {
+            queryParameters['offset'] = requestParameters['offset'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearerAuth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/api/v1/datasets`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Cost: 5-15 credits, by rows returned.
+     * List datasets
+     */
+    async listDatasetsRaw(requestParameters: ListDatasetsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListDatasets200Response>> {
+        const requestOptions = await this.listDatasetsRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ListDatasets200ResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Cost: 5-15 credits, by rows returned.
+     * List datasets
+     */
+    async listDatasets(requestParameters: ListDatasetsRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListDatasets200Response> {
+        const response = await this.listDatasetsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}
+
+/**
+ * @export
+ */
+export const ListDatasetsSortEnum = {
+    Downloads: 'downloads',
+    Downloads2: '-downloads',
+    Likes: 'likes',
+    Likes2: '-likes',
+    Created: 'created',
+    Created2: '-created',
+    CreatedAt: 'created_at',
+    CreatedAt2: '-created_at',
+    FirstSeen: 'first_seen',
+    FirstSeen2: '-first_seen',
+    FirstSeenAt: 'first_seen_at',
+    FirstSeenAt2: '-first_seen_at',
+} as const;
+export type ListDatasetsSortEnum = typeof ListDatasetsSortEnum[keyof typeof ListDatasetsSortEnum];

package/src/apis/IndicesApi.ts

@@ -0,0 +1,213 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * abliteration.org Public API
+ * Read access to the abliteration.org catalog: models and their method classification, alignment datasets and their passports, the M-code taxonomy, the four flagship indices and the curated field timeline.  Every call is authenticated with a bearer key and metered in credits against the same wallet the Research Agent spends from. There is no free tier for machine traffic and no separate billing.  Responses report `cost` and `credits_remaining` on every success. While `metering` reads `preview`, the cost shown is what the call will bill once metering is enabled and nothing is actually deducted; when it reads `billed`, it was.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import * as runtime from '../runtime';
+import {
+    type GetIndex200Response,
+    GetIndex200ResponseFromJSON,
+    GetIndex200ResponseToJSON,
+} from '../models/GetIndex200Response';
+import {
+    type ListIndices200Response,
+    ListIndices200ResponseFromJSON,
+    ListIndices200ResponseToJSON,
+} from '../models/ListIndices200Response';
+
+export interface GetIndexRequest {
+    /**
+     * Canonical id or one of the short aliases (DAI, FV, WEAP, F2W). Case-insensitive.
+     */
+    id: GetIndexIdEnum;
+}
+
+/**
+ * IndicesApi - interface
+ * 
+ * @export
+ * @interface IndicesApiInterface
+ */
+export interface IndicesApiInterface {
+    /**
+     * Creates request options for getIndex without sending the request
+     * @param {'dai' | 'DAI' | 'freedom-velocity' | 'FV' | 'freedom_velocity' | 'weaponization' | 'WEAP' | 'f2w-latency' | 'F2W' | 'f2w_latency'} id Canonical id or one of the short aliases (DAI, FV, WEAP, F2W). Case-insensitive.
+     * @throws {RequiredError}
+     * @memberof IndicesApiInterface
+     */
+    getIndexRequestOpts(requestParameters: GetIndexRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * Cost: 10 credits. Only dai has a history series; the others return an empty array with history_available false.
+     * @summary One index with history
+     * @param {'dai' | 'DAI' | 'freedom-velocity' | 'FV' | 'freedom_velocity' | 'weaponization' | 'WEAP' | 'f2w-latency' | 'F2W' | 'f2w_latency'} id Canonical id or one of the short aliases (DAI, FV, WEAP, F2W). Case-insensitive.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof IndicesApiInterface
+     */
+    getIndexRaw(requestParameters: GetIndexRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetIndex200Response>>;
+
+    /**
+     * Cost: 10 credits. Only dai has a history series; the others return an empty array with history_available false.
+     * One index with history
+     */
+    getIndex(requestParameters: GetIndexRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetIndex200Response>;
+
+    /**
+     * Creates request options for listIndices without sending the request
+     * @throws {RequiredError}
+     * @memberof IndicesApiInterface
+     */
+    listIndicesRequestOpts(): Promise<runtime.RequestOpts>;
+
+    /**
+     * Cost: 20 credits. Check the measured flag before treating a value as a finding.
+     * @summary All four indices
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof IndicesApiInterface
+     */
+    listIndicesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListIndices200Response>>;
+
+    /**
+     * Cost: 20 credits. Check the measured flag before treating a value as a finding.
+     * All four indices
+     */
+    listIndices(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListIndices200Response>;
+
+}
+
+/**
+ * 
+ */
+export class IndicesApi extends runtime.BaseAPI implements IndicesApiInterface {
+
+    /**
+     * Creates request options for getIndex without sending the request
+     */
+    async getIndexRequestOpts(requestParameters: GetIndexRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling getIndex().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearerAuth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/api/v1/indices/{id}`;
+        urlPath = urlPath.replace('{id}', encodeURIComponent(String(requestParameters['id'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Cost: 10 credits. Only dai has a history series; the others return an empty array with history_available false.
+     * One index with history
+     */
+    async getIndexRaw(requestParameters: GetIndexRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetIndex200Response>> {
+        const requestOptions = await this.getIndexRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetIndex200ResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Cost: 10 credits. Only dai has a history series; the others return an empty array with history_available false.
+     * One index with history
+     */
+    async getIndex(requestParameters: GetIndexRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetIndex200Response> {
+        const response = await this.getIndexRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for listIndices without sending the request
+     */
+    async listIndicesRequestOpts(): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearerAuth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/api/v1/indices`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Cost: 20 credits. Check the measured flag before treating a value as a finding.
+     * All four indices
+     */
+    async listIndicesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListIndices200Response>> {
+        const requestOptions = await this.listIndicesRequestOpts();
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ListIndices200ResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Cost: 20 credits. Check the measured flag before treating a value as a finding.
+     * All four indices
+     */
+    async listIndices(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListIndices200Response> {
+        const response = await this.listIndicesRaw(initOverrides);
+        return await response.value();
+    }
+
+}
+
+/**
+ * @export
+ */
+export const GetIndexIdEnum = {
+    Dai: 'dai',
+    Dai2: 'DAI',
+    FreedomVelocity: 'freedom-velocity',
+    Fv: 'FV',
+    FreedomVelocity2: 'freedom_velocity',
+    Weaponization: 'weaponization',
+    Weap: 'WEAP',
+    F2wLatency: 'f2w-latency',
+    F2W: 'F2W',
+    F2wLatency2: 'f2w_latency',
+} as const;
+export type GetIndexIdEnum = typeof GetIndexIdEnum[keyof typeof GetIndexIdEnum];