@deeprelay/sdk 0.1.1 → 0.2.0

package/docs/OperationsApi.md

@@ -1,80 +0,0 @@
-# OperationsApi
-
-All URIs are relative to *https://api.deeprelay.ai/v1*
-
-| Method | HTTP request | Description |
-|------------- | ------------- | -------------|
-| [**getOperation**](OperationsApi.md#getoperation) | **GET** /operations/{id} | Get an async operation status |
-
-
-
-## getOperation
-
-> Operation getOperation(id)
-
-Get an async operation status
-
-### Example
-
-```ts
-import {
-  Configuration,
-  OperationsApi,
-} from '@deeprelay/sdk';
-import type { GetOperationRequest } from '@deeprelay/sdk';
-
-async function example() {
-  console.log("🚀 Testing @deeprelay/sdk SDK...");
-  const config = new Configuration({ 
-    // Configure HTTP bearer authorization: bearerAuth
-    accessToken: "YOUR BEARER TOKEN",
-  });
-  const api = new OperationsApi(config);
-
-  const body = {
-    // string
-    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
-  } satisfies GetOperationRequest;
-
-  try {
-    const data = await api.getOperation(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
-
-[**Operation**](Operation.md)
-
-### Authorization
-
-[bearerAuth](../README.md#bearerAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: `application/json`, `application/problem+json`
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-| **200** | OK |  -  |
-| **429** | Rate limit exceeded (RFC 7807). Retry-After header indicates seconds to wait. |  * Retry-After - Seconds the client should wait before retrying. <br>  |
-| **0** | Error response (RFC 7807) |  -  |
-
-[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
-

package/src/apis/OperationsApi.ts

@@ -1,89 +0,0 @@
-/* tslint:disable */
-/* eslint-disable */
-/**
- * deeprelay Public Developer API
- * Programmatic API for deeprelay. Authenticate with API keys minted from the dashboard. See https://deeprelay.ai/docs for details. 
- *
- * The version of the OpenAPI document: 1.0.0
- * Contact: support@deeprelay.ai
- *
- * 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 Operation,
-    OperationFromJSON,
-    OperationToJSON,
-} from '../models/Operation';
-import {
-    type Problem,
-    ProblemFromJSON,
-    ProblemToJSON,
-} from '../models/Problem';
-
-export interface GetOperationRequest {
-    id: string;
-}
-
-/**
- * 
- */
-export class OperationsApi extends runtime.BaseAPI {
-
-    /**
-     * Creates request options for getOperation without sending the request
-     */
-    async getOperationRequestOpts(requestParameters: GetOperationRequest): Promise<runtime.RequestOpts> {
-        if (requestParameters['id'] == null) {
-            throw new runtime.RequiredError(
-                'id',
-                'Required parameter "id" was null or undefined when calling getOperation().'
-            );
-        }
-
-        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 = `/operations/{id}`;
-        urlPath = urlPath.replace('{id}', encodeURIComponent(String(requestParameters['id'])));
-
-        return {
-            path: urlPath,
-            method: 'GET',
-            headers: headerParameters,
-            query: queryParameters,
-        };
-    }
-
-    /**
-     * Get an async operation status
-     */
-    async getOperationRaw(requestParameters: GetOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Operation>> {
-        const requestOptions = await this.getOperationRequestOpts(requestParameters);
-        const response = await this.request(requestOptions, initOverrides);
-
-        return new runtime.JSONApiResponse(response, (jsonValue) => OperationFromJSON(jsonValue));
-    }
-
-    /**
-     * Get an async operation status
-     */
-    async getOperation(requestParameters: GetOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Operation> {
-        const response = await this.getOperationRaw(requestParameters, initOverrides);
-        return await response.value();
-    }
-
-}

package/src/models/Operation.ts

@@ -1,179 +0,0 @@
-/* tslint:disable */
-/* eslint-disable */
-/**
- * deeprelay Public Developer API
- * Programmatic API for deeprelay. Authenticate with API keys minted from the dashboard. See https://deeprelay.ai/docs for details. 
- *
- * The version of the OpenAPI document: 1.0.0
- * Contact: support@deeprelay.ai
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-
-import { mapValues } from '../runtime';
-import type { OperationResult } from './OperationResult';
-import {
-    OperationResultFromJSON,
-    OperationResultFromJSONTyped,
-    OperationResultToJSON,
-    OperationResultToJSONTyped,
-} from './OperationResult';
-import type { OperationError } from './OperationError';
-import {
-    OperationErrorFromJSON,
-    OperationErrorFromJSONTyped,
-    OperationErrorToJSON,
-    OperationErrorToJSONTyped,
-} from './OperationError';
-
-/**
- * 
- * @export
- * @interface Operation
- */
-export interface Operation {
-    /**
-     * 
-     * @type {string}
-     * @memberof Operation
-     */
-    operationId: string;
-    /**
-     * 
-     * @type {OperationKindEnum}
-     * @memberof Operation
-     */
-    kind: OperationKindEnum;
-    /**
-     * 
-     * @type {OperationStateEnum}
-     * @memberof Operation
-     */
-    state: OperationStateEnum;
-    /**
-     * 
-     * @type {string}
-     * @memberof Operation
-     */
-    resourceId?: string;
-    /**
-     * 
-     * @type {OperationError}
-     * @memberof Operation
-     */
-    error?: OperationError;
-    /**
-     * 
-     * @type {OperationResult}
-     * @memberof Operation
-     */
-    result?: OperationResult;
-    /**
-     * 
-     * @type {Date}
-     * @memberof Operation
-     */
-    createdAt: Date;
-    /**
-     * 
-     * @type {Date}
-     * @memberof Operation
-     */
-    updatedAt?: Date;
-    /**
-     * 
-     * @type {Date}
-     * @memberof Operation
-     */
-    completedAt?: Date;
-    /**
-     * Create-time advisories, present only on the synchronous 202 from POST /instances (never on GET /operations/{id} polls) — e.g. the model-size guard failing open because a template deploy's MODEL is a gated or unknown Hugging Face repo whose size could not be verified.
-     * @type {Array<string>}
-     * @memberof Operation
-     */
-    warnings?: Array<string>;
-}
-
-
-/**
- * @export
- */
-export const OperationKindEnum = {
-    InstanceCreate: 'instance.create',
-    InstanceDelete: 'instance.delete'
-} as const;
-export type OperationKindEnum = typeof OperationKindEnum[keyof typeof OperationKindEnum];
-
-/**
- * @export
- */
-export const OperationStateEnum = {
-    Pending: 'pending',
-    InProgress: 'in_progress',
-    Succeeded: 'succeeded',
-    Failed: 'failed',
-    Cancelled: 'cancelled'
-} as const;
-export type OperationStateEnum = typeof OperationStateEnum[keyof typeof OperationStateEnum];
-
-
-/**
- * Check if a given object implements the Operation interface.
- */
-export function instanceOfOperation(value: object): value is Operation {
-    if ((!('operationId' in (value as Record<string, any>)) && !('operation_id' in (value as Record<string, any>))) || ((value as Record<string, any>)['operationId'] === undefined && (value as Record<string, any>)['operation_id'] === undefined)) return false;
-    if (!('kind' in value) || value['kind'] === undefined) return false;
-    if (!('state' in value) || value['state'] === undefined) return false;
-    if ((!('createdAt' in (value as Record<string, any>)) && !('created_at' in (value as Record<string, any>))) || ((value as Record<string, any>)['createdAt'] === undefined && (value as Record<string, any>)['created_at'] === undefined)) return false;
-    return true;
-}
-
-export function OperationFromJSON(json: any): Operation {
-    return OperationFromJSONTyped(json, false);
-}
-
-export function OperationFromJSONTyped(json: any, ignoreDiscriminator: boolean): Operation {
-    if (json == null) {
-        return json;
-    }
-    return {
-        
-        'operationId': json['operation_id'],
-        'kind': json['kind'],
-        'state': json['state'],
-        'resourceId': json['resource_id'] == null ? undefined : json['resource_id'],
-        'error': json['error'] == null ? undefined : OperationErrorFromJSON(json['error']),
-        'result': json['result'] == null ? undefined : OperationResultFromJSON(json['result']),
-        'createdAt': (new Date(json['created_at'])),
-        'updatedAt': json['updated_at'] == null ? undefined : (new Date(json['updated_at'])),
-        'completedAt': json['completed_at'] == null ? undefined : (new Date(json['completed_at'])),
-        'warnings': json['warnings'] == null ? undefined : json['warnings'],
-    };
-}
-
-export function OperationToJSON(json: any): Operation {
-    return OperationToJSONTyped(json, false);
-}
-
-export function OperationToJSONTyped(value?: Operation | null, ignoreDiscriminator: boolean = false): any {
-    if (value == null) {
-        return value;
-    }
-
-    return {
-        
-        'operation_id': value['operationId'],
-        'kind': value['kind'],
-        'state': value['state'],
-        'resource_id': value['resourceId'],
-        'error': OperationErrorToJSON(value['error']),
-        'result': OperationResultToJSON(value['result']),
-        'created_at': value['createdAt'].toISOString(),
-        'updated_at': value['updatedAt'] == null ? value['updatedAt'] : value['updatedAt'].toISOString(),
-        'completed_at': value['completedAt'] == null ? value['completedAt'] : value['completedAt'].toISOString(),
-        'warnings': value['warnings'],
-    };
-}
-

package/src/models/OperationError.ts

@@ -1,73 +0,0 @@
-/* tslint:disable */
-/* eslint-disable */
-/**
- * deeprelay Public Developer API
- * Programmatic API for deeprelay. Authenticate with API keys minted from the dashboard. See https://deeprelay.ai/docs for details. 
- *
- * The version of the OpenAPI document: 1.0.0
- * Contact: support@deeprelay.ai
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-
-import { mapValues } from '../runtime';
-/**
- * 
- * @export
- * @interface OperationError
- */
-export interface OperationError {
-    /**
-     * 
-     * @type {string}
-     * @memberof OperationError
-     */
-    code?: string;
-    /**
-     * 
-     * @type {string}
-     * @memberof OperationError
-     */
-    detail?: string;
-}
-
-/**
- * Check if a given object implements the OperationError interface.
- */
-export function instanceOfOperationError(value: object): value is OperationError {
-    return true;
-}
-
-export function OperationErrorFromJSON(json: any): OperationError {
-    return OperationErrorFromJSONTyped(json, false);
-}
-
-export function OperationErrorFromJSONTyped(json: any, ignoreDiscriminator: boolean): OperationError {
-    if (json == null) {
-        return json;
-    }
-    return {
-        
-        'code': json['code'] == null ? undefined : json['code'],
-        'detail': json['detail'] == null ? undefined : json['detail'],
-    };
-}
-
-export function OperationErrorToJSON(json: any): OperationError {
-    return OperationErrorToJSONTyped(json, false);
-}
-
-export function OperationErrorToJSONTyped(value?: OperationError | null, ignoreDiscriminator: boolean = false): any {
-    if (value == null) {
-        return value;
-    }
-
-    return {
-        
-        'code': value['code'],
-        'detail': value['detail'],
-    };
-}
-

package/src/models/OperationResult.ts

@@ -1,81 +0,0 @@
-/* tslint:disable */
-/* eslint-disable */
-/**
- * deeprelay Public Developer API
- * Programmatic API for deeprelay. Authenticate with API keys minted from the dashboard. See https://deeprelay.ai/docs for details. 
- *
- * The version of the OpenAPI document: 1.0.0
- * Contact: support@deeprelay.ai
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-
-import { mapValues } from '../runtime';
-/**
- * Terminal-success payload. Carries the per-instance web-access coordinates — app_url for template deploys, terminal_url for instances provisioned with the browser web console, and the basic-auth username shared by both. The basic-auth PASSWORD is never included here — retrieve it via GET /instances/{id}?include=credentials (connection.app_password).
- * @export
- * @interface OperationResult
- */
-export interface OperationResult {
-    /**
-     * 
-     * @type {string}
-     * @memberof OperationResult
-     */
-    appUrl?: string;
-    /**
-     * 
-     * @type {string}
-     * @memberof OperationResult
-     */
-    terminalUrl?: string;
-    /**
-     * 
-     * @type {string}
-     * @memberof OperationResult
-     */
-    appBasicAuthUser?: string;
-}
-
-/**
- * Check if a given object implements the OperationResult interface.
- */
-export function instanceOfOperationResult(value: object): value is OperationResult {
-    return true;
-}
-
-export function OperationResultFromJSON(json: any): OperationResult {
-    return OperationResultFromJSONTyped(json, false);
-}
-
-export function OperationResultFromJSONTyped(json: any, ignoreDiscriminator: boolean): OperationResult {
-    if (json == null) {
-        return json;
-    }
-    return {
-        
-        'appUrl': json['app_url'] == null ? undefined : json['app_url'],
-        'terminalUrl': json['terminal_url'] == null ? undefined : json['terminal_url'],
-        'appBasicAuthUser': json['app_basic_auth_user'] == null ? undefined : json['app_basic_auth_user'],
-    };
-}
-
-export function OperationResultToJSON(json: any): OperationResult {
-    return OperationResultToJSONTyped(json, false);
-}
-
-export function OperationResultToJSONTyped(value?: OperationResult | null, ignoreDiscriminator: boolean = false): any {
-    if (value == null) {
-        return value;
-    }
-
-    return {
-        
-        'app_url': value['appUrl'],
-        'terminal_url': value['terminalUrl'],
-        'app_basic_auth_user': value['appBasicAuthUser'],
-    };
-}
-