@picteus/ws-client

v0.10.0

Published

10 days ago

OpenAPI client for @picteus/ws-client

Downloads

0High
0Medium
0Low

koppasoft

@picteus/[email protected]

A TypeScript SDK client for the localhost API.

Usage

First, install the SDK from npm.

npm install @picteus/ws-client --save

Next, try it out.

import {
  Configuration,
  AdministrationApi,
} from '@picteus/ws-client';
import type { AdministrationMigrateDatabaseRequest } from '@picteus/ws-client';

async function example() {
  console.log("🚀 Testing @picteus/ws-client SDK...");
  const config = new Configuration({ 
    // To configure API key authorization: api-key
    apiKey: "YOUR API KEY",
  });
  const api = new AdministrationApi(config);

  try {
    const data = await api.administrationMigrateDatabase();
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);

Documentation

API Endpoints

All URIs are relative to https://localhost:3001

| Class | Method | HTTP request | Description | ----- | ------ | ------------ | ------------- AdministrationApi | administrationMigrateDatabase | PUT /administration/migrateDatabase | Migrates the database ApiSecretApi | apisecretCreate | POST /apiSecret/create | Creates an API secret ApiSecretApi | apisecretDelete | DELETE /apiSecret/{id}/delete | Deletes an API secret ApiSecretApi | apisecretGet | GET /apiSecret/{id}/get | Gets an API secret ApiSecretApi | apisecretList | GET /apiSecret/list | Lists all API secrets CollectionApi | collectionCreate | POST /collection/create | Creates a collection CollectionApi | collectionDelete | DELETE /collection/{id}/delete | Deletes collection CollectionApi | collectionGet | GET /collection/{id}/get | Gets a collection CollectionApi | collectionList | GET /collection/list | Lists all collections CollectionApi | collectionUpdate | PUT /collection/{id}/update | Updates a collection ExtensionApi | extensionActivities | GET /extension/activities | Indicates the extension activities ExtensionApi | extensionBuild | PUT /extension/build | Builds an extension ExtensionApi | extensionGenerate | PUT /extension/generate | Generates an extension ExtensionApi | extensionGet | GET /extension/{id}/get | Gets an extension ExtensionApi | extensionGetConfiguration | GET /extension/getConfiguration | Provides the extensions configuration ExtensionApi | extensionGetSettings | GET /extension/{id}/getSettings | Gets an extension settings ExtensionApi | extensionInstall | POST /extension/install | Installs an extension ExtensionApi | extensionInstallChromeExtension | PUT /extension/{id}/installChromeExtension | Installs a Chrome extension ExtensionApi | extensionList | GET /extension/list | Lists all extensions ExtensionApi | extensionPauseOrResume | PUT /extension/{id}/pauseOrResume | Pauses or resumes an extension ExtensionApi | extensionRunImageCommand | PUT /extension/{id}/runImageCommand | Runs a command exposed by an extension, on images ExtensionApi | extensionRunProcessCommand | PUT /extension/{id}/runProcessCommand | Runs a command exposed by an extension, on the process ExtensionApi | extensionSetSettings | PUT /extension/{id}/setSettings | Sets an extension settings ExtensionApi | extensionSynchronize | PUT /extension/{id}/synchronize | Synchronizes the images via an extension ExtensionApi | extensionUninstall | DELETE /extension/{id}/uninstall | Uninstalls an extension ExtensionApi | extensionUpdate | PUT /extension/{id}/update | Updates an extension ImageApi | imageClosestEmbeddingsImages | PUT /image/closestEmbeddingsImages | Gets the closest images to some embeddings attached to an extension ImageApi | imageClosestImages | GET /image/{id}/closestImages | Gets the closest images to the image following the embeddings of an extension ImageApi | imageComputeFormat | PUT /image/format | Computes the format of an image ImageApi | imageConvert | PUT /image/convert | Converts an image into a format ImageApi | imageDelete | DELETE /image/{id}/delete | Deletes an image ImageApi | imageDownload | GET /image/{id}/download | Downloads an image ImageApi | imageEnsureTags | PUT /image/{id}/ensureTags | Ensures that the tags are set on an image ImageApi | imageGet | GET /image/{id}/get | Gets an image ImageApi | imageGetAllEmbeddings | GET /image/{id}/getAllEmbeddings | Gets all the embeddings of an image ImageApi | imageGetAllFeatures | GET /image/{id}/getAllFeatures | Gets all the features of an image ImageApi | imageGetAllRecipes | GET /image/{id}/getAllRecipes | Gets all the recipes of an image ImageApi | imageGetAllTags | GET /image/{id}/getAllTags | Gets all the tags of an image ImageApi | imageGetEmbeddings | GET /image/{id}/getEmbeddings | Gets the embeddings of an image ImageApi | imageGetFeatures | GET /image/{id}/getFeatures | Gets all the features of an image for an extension ImageApi | imageGetMetadata | GET /image/{id}/metadata | Gets the metadata of an image ImageApi | imageGetTags | GET /image/{id}/getTags | Gets the tags of an image for an extension ImageApi | imageMediaUrl | GET /image/{id}/mediaUrl | Gets an URL of the image ImageApi | imageModify | PUT /image/{id}/modify | Modifies an image ImageApi | imageSearch | GET /image/search | Searches images ImageApi | imageSetEmbeddings | PUT /image/{id}/setEmbeddings | Sets the embeddings of an image ImageApi | imageSetFeatures | PUT /image/{id}/setFeatures | Sets the features of an image ImageApi | imageSetTags | PUT /image/{id}/setTags | Sets the tags of an image ImageApi | imageSynchronize | PUT /image/{id}/synchronize | Synchronizes an image ImageApi | imageTextToImages | GET /image/textToImages | Gets the closest images to a text following the embeddings of an extension ImageAttachmentApi | imageattachmentCreate | POST /imageAttachment/create | Declares an image binary attachment ImageAttachmentApi | imageattachmentDownload | GET /imageAttachment/{uri}/download | Downloads an image binary attachment MiscellaneousApi | miscellaneousPing | GET /miscellaneous/ping | Pings the service MiscellaneousApi | miscellaneousTest | GET /miscellaneous/test | Runs a test RepositoryApi | repositoryActivities | GET /repository/activities | Indicates the repositories activities RepositoryApi | repositoryCreate | POST /repository/create | Creates a repository RepositoryApi | repositoryDelete | DELETE /repository/{id}/delete | Deletes a repository RepositoryApi | repositoryEnsure | PUT /repository/ensure | Ensures a repository exists RepositoryApi | repositoryGet | GET /repository/{id}/get | Gets a repository RepositoryApi | repositoryGetFeatureNames | GET /repository/featureNames | Gets all the feature names RepositoryApi | repositoryGetImageByUrl | GET /repository/getImageByUrl | Gets an image from its URL RepositoryApi | repositoryGetTags | GET /repository/tags | Gets all the tags RepositoryApi | repositoryList | GET /repository/list | Lists repositories RepositoryApi | repositoryRenameImage | PUT /repository/{id}/renameImage | Renames an image RepositoryApi | repositoryStartOrStop | PUT /repository/startOrStop | Starts or stop the repositories RepositoryApi | repositoryStoreImage | POST /repository/{id}/storeImage | Creates an image in the repository RepositoryApi | repositorySynchronize | PUT /repository/{id}/synchronize | Synchronizes a repository RepositoryApi | repositoryWatch | PUT /repository/{id}/watch | Starts or stops watching a repository SettingsApi | settingsGet | GET /settings/get | Gets all the settings SettingsApi | settingsSet | PUT /settings/set | Sets all the settings

Models

Authorization

Authentication schemes defined for the API:

api-key

Type: API key
API key parameter name: X-API-KEY
Location: HTTP header

About

This TypeScript SDK client supports the Fetch API and is automatically generated by the OpenAPI Generator project:

API version: 0.10.0
Package version: 0.10.0
Generator version: 7.17.0
Build package: org.openapitools.codegen.languages.TypeScriptFetchClientCodegen

The generated npm module supports the following:

Environments
- Node.js
- Webpack
- Browserify
Language levels
- ES5 - you must have a Promises/A+ library installed
- ES6
Module systems
- CommonJS
- ES6 module system

For more information, please visit https://www.linkedin.com/in/edouardmercier

Development

Building

To build the TypeScript source code, you need to have Node.js and npm installed. After cloning the repository, navigate to the project directory and run:

npm install
npm run build

Publishing

Once you've built the package, you can publish it to npm:

npm publish

License

LicenseRef-GNU Affero General Public License