@cosmotech/[email protected]

This generator creates TypeScript/JavaScript client that utilizes axios. The generated Node module can be used in the following environments:

Environment

• Node.js
• Webpack
• Browserify

Language level

• ES5 - you must have a Promises/A+ library installed
• ES6

Module system

• CommonJS
• ES6 module system

It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via package.json. (Reference)

Building

To build and compile the typescript sources to javascript use:

npm install
npm run build

Publishing

First build the package then run npm publish

Consuming

navigate to the folder of your consuming project and run one of the following commands.

published:

npm install @cosmotech/[email protected] --save

unPublished (not recommended):

npm install PATH_TO_GENERATED_PACKAGE --save

Documentation for API Endpoints

All URIs are relative to http://localhost

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- ConceptualModelApi | checkConceptualModelSemanticErrors | POST /projects/{projectId}/conceptualModels/semantic | Check the semantic of a submitted conceptual model ConceptualModelApi | createCategory | POST /projects/{projectId}/conceptualModels/{conceptualModelId}/categories | Create a new category ConceptualModelApi | createConceptualModel | POST /projects/{projectId}/conceptualModels/{conceptualModelId} | Create a new conceptual model ConceptualModelApi | createDataType | POST /projects/{projectId}/conceptualModels/{conceptualModelId}/dataTypes | Create a new data type ConceptualModelApi | createEntity | POST /projects/{projectId}/conceptualModels/{conceptualModelId}/entities | Create a new entity ConceptualModelApi | createEnvironment | POST /projects/{projectId}/conceptualModels/{conceptualModelId}/environments | Create a new environment ConceptualModelApi | deleteCategory | DELETE /projects/{projectId}/conceptualModels/{conceptualModelId}/categories/{categoryId} | Delete a category ConceptualModelApi | deleteConceptualModel | DELETE /projects/{projectId}/conceptualModels/{conceptualModelId} | Delete a conceptal model ConceptualModelApi | deleteDataType | DELETE /projects/{projectId}/conceptualModels/{conceptualModelId}/dataTypes/{dataTypeId} | Delete a data type ConceptualModelApi | deleteEntity | DELETE /projects/{projectId}/conceptualModels/{conceptualModelId}/entities/{entityId} | Delete an entity ConceptualModelApi | deleteEnvironment | DELETE /projects/{projectId}/conceptualModels/{conceptualModelId}/environments/{environmentId} | Delete an environment ConceptualModelApi | getCategory | GET /projects/{projectId}/conceptualModels/{conceptualModelId}/categories/{categoryId} | Get a category definition ConceptualModelApi | getConceptualModel | GET /projects/{projectId}/conceptualModels/{conceptualModelId} | Get the content of a conceptual model ConceptualModelApi | getConceptualModelSemanticErrors | GET /projects/{projectId}/conceptualModels/{conceptualModelId}/semantic | Check the semantic of a submitted conceptual model ConceptualModelApi | getDataType | GET /projects/{projectId}/conceptualModels/{conceptualModelId}/dataTypes/{dataTypeId} | Get a data type definition ConceptualModelApi | getEntity | GET /projects/{projectId}/conceptualModels/{conceptualModelId}/entities/{entityId} | Get an entity definition ConceptualModelApi | getEnvironment | GET /projects/{projectId}/conceptualModels/{conceptualModelId}/environments/{environmentId} | Get an environment definition ConceptualModelApi | listCategories | GET /projects/{projectId}/conceptualModels/{conceptualModelId}/categories | Get the list of categories of a model ConceptualModelApi | listConceptualModels | GET /projects/{projectId}/conceptualModels | List the conceptual models of a project ConceptualModelApi | listDataTypes | GET /projects/{projectId}/conceptualModels/{conceptualModelId}/dataTypes | Get the list of data types of a model ConceptualModelApi | listEntities | GET /projects/{projectId}/conceptualModels/{conceptualModelId}/entities | Get the list of entities of a model ConceptualModelApi | listEnvironments | GET /projects/{projectId}/conceptualModels/{conceptualModelId}/environments | Get the list of environments of a model ConceptualModelApi | replaceCategory | PUT /projects/{projectId}/conceptualModels/{conceptualModelId}/categories/{categoryId} | Replace a category definition ConceptualModelApi | replaceConceptualModel | PUT /projects/{projectId}/conceptualModels/{conceptualModelId} | Replace the content of a conceptual model ConceptualModelApi | replaceDataType | PUT /projects/{projectId}/conceptualModels/{conceptualModelId}/dataTypes/{dataTypeId} | Replace a data type definition ConceptualModelApi | replaceEntity | PUT /projects/{projectId}/conceptualModels/{conceptualModelId}/entities/{entityId} | Replace an entity definition ConceptualModelApi | replaceEnvironment | PUT /projects/{projectId}/conceptualModels/{conceptualModelId}/environments/{environmentId} | Replace an environment definition ConceptualModelApi | updateConceptualModel | PATCH /projects/{projectId}/conceptualModels/{conceptualModelId} | Update the content of a conceptual model FileApi | createProjectFile | POST /projects/{projectId}/files/raw | Create a new project file FileApi | deleteProjectFile | DELETE /projects/{projectId}/files/raw | Delete a project file FileApi | getProjectFile | GET /projects/{projectId}/files/raw | Get the content of a project file FileApi | listProjectFiles | GET /projects/{projectId}/files | List all files of a project FileApi | replaceProjectFile | PUT /projects/{projectId}/files/raw | Replace a project file MetaApi | about | GET /about | Retrieve API info MetaApi | getOpenapi | GET /openapi.yaml | Get the OpenAPI description file MetaApi | getSchema | GET /schemas/{schemaId} | Get a schema content MetaApi | listSchemas | GET /schemas | List all known JSON schemas ProjectApi | createProject | POST /projects | Create new a project ProjectApi | deleteProject | DELETE /projects/{projectId} | Delete a project ProjectApi | deleteProjectArchive | DELETE /projects/{projectId}/archive | Delete the project archive ProjectApi | getProject | GET /projects/{projectId} | List a project details ProjectApi | getProjectArchive | GET /projects/{projectId}/archive | Get the current project archive ProjectApi | listProjects | GET /projects | List all projects ProjectApi | replaceProjectArchive | PUT /projects/{projectId}/archive | Upload a replacement project source archive ProjectApi | updateProject | PATCH /projects/{projectId} | Update a project ProjectApi | uploadProjectArchive | POST /projects/{projectId}/archive | Upload the initial project source archive ProjectBuildApi | buildProject | POST /projects/{projectId}/builds | Build a project ProjectBuildApi | deleteProjectBuild | DELETE /projects/{projectId}/builds/{buildId} | Delete a project build ProjectBuildApi | getProjectBuild | GET /projects/{projectId}/builds/{buildId} | List a project build details ProjectBuildApi | getProjectBuildLogs | GET /projects/{projectId}/builds/{buildId}/logs | Get a project build logs ProjectBuildApi | getProjectBuildPackage | GET /projects/{projectId}/builds/{buildId}/package | Get the produced built package ProjectBuildApi | listProjectBuilds | GET /projects/{projectId}/builds | List all builds of a project SimulatorApi | checkSimulatorSemanticErrors | POST /projects/{projectId}/simulators/semantic | Check the semantic of a submitted simulator SimulatorApi | createProbe | POST /projects/{projectId}/simulators/{simulatorId}/probes | Create a new probe SimulatorApi | createSimulator | POST /projects/{projectId}/simulators/{simulatorId} | Create a new simulator SimulatorApi | deleteProbe | DELETE /projects/{projectId}/simulators/{simulatorId}/probes/{probeId} | Delete a probe SimulatorApi | deleteSimulator | DELETE /projects/{projectId}/simulators/{simulatorId} | Delete a simulator SimulatorApi | getProbe | GET /projects/{projectId}/simulators/{simulatorId}/probes/{probeId} | Get a probe definition SimulatorApi | getSimulator | GET /projects/{projectId}/simulators/{simulatorId} | Get the content of a simulator SimulatorApi | getSimulatorSemanticErrors | GET /projects/{projectId}/simulators/{simulatorId}/semantic | Check the semantic of a submitted simulator SimulatorApi | listProbes | GET /projects/{projectId}/simulators/{simulatorId}/probes | Get the list of probes of a simulator SimulatorApi | listSimulators | GET /projects/{projectId}/simulators | List the simulators of a project SimulatorApi | replaceProbe | PUT /projects/{projectId}/simulators/{simulatorId}/probes/{probeId} | Replace a probe definition SimulatorApi | replaceSimulator | PUT /projects/{projectId}/simulators/{simulatorId} | Replace the content of a simulator SimulatorApi | updateSimulator | PATCH /projects/{projectId}/simulators/{simulatorId} | Update the content of a simulator TransformationsApi | checkTransformationsSemanticErrors | POST /projects/{projectId}/transformations/semantic | Check the semantic of a submitted transformations TransformationsApi | createOperation | POST /projects/{projectId}/transformations/{transformationsId}/operations | Create a new operation TransformationsApi | createTransformations | POST /projects/{projectId}/transformations/{transformationsId} | Create a new transformations TransformationsApi | deleteOperation | DELETE /projects/{projectId}/transformations/{transformationsId}/operations/{operationId} | Delete an operation TransformationsApi | deleteTransformations | DELETE /projects/{projectId}/transformations/{transformationsId} | Delete a transformations TransformationsApi | getBuildingWorkspaceForOperation | GET /projects/{projectId}/transformations/{transformationsId}/operations/{operationId}/buildingWorkspace | Get the building workspace on which an operation can work TransformationsApi | getOperation | GET /projects/{projectId}/transformations/{transformationsId}/operations/{operationId} | Get an operation definition TransformationsApi | getResultingModel | GET /projects/{projectId}/transformations/{transformationsId}/resultingModel | Get the final resulting model of a transformations resource TransformationsApi | getResultingModelAfterOperation | GET /projects/{projectId}/transformations/{transformationsId}/operations/{operationId}/resultingModel | Get the resulting model after a specific operation of a transformations resource TransformationsApi | getSemanticErrorsForResultingModelAfterOperation | GET /projects/{projectId}/transformations/{transformationsId}/operations/{operationId}/resultingModel/semantic | Get the semantic errors of a resulting model after a specific operations of transformations TransformationsApi | getTransformations | GET /projects/{projectId}/transformations/{transformationsId} | Get the content of a transformations TransformationsApi | getTransformationsSemanticErrors | GET /projects/{projectId}/transformations/{transformationsId}/semantic | Check the semantic of a submitted transformations TransformationsApi | listOperations | GET /projects/{projectId}/transformations/{transformationsId}/operations | Get the list of operations of a transformations TransformationsApi | listTransformations | GET /projects/{projectId}/transformations | List the transformations of a project TransformationsApi | replaceOperation | PUT /projects/{projectId}/transformations/{transformationsId}/operations/{operationId} | Replace an operation definition TransformationsApi | replaceTransformations | PUT /projects/{projectId}/transformations/{transformationsId} | Replace the content of a transformations TransformationsApi | updateTransformations | PATCH /projects/{projectId}/transformations/{transformationsId} | Update the content of a transformations

Documentation For Models

• AboutInfo
• AboutInfoVersion
• ProblemDetails
• ProblemDetailsSemanticErrors
• Project
• ProjectBuild
• ProjectBuildRequest
• ProjectBuildRequestBuildConfig
• ProjectBuildRequestDockerSimulatorImage
• ProjectBuildStatus
• ProjectRequest
• SemanticError
• SemanticErrorNodes

Documentation For Authorization

Endpoints do not require authorization.