@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)
To build and compile the typescript sources to javascript use:
npm install
npm run build
First build the package then run npm publish
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
All URIs are relative to http://localhost:8080
| Class | Method | HTTP request | Description |
|---|---|---|---|
| DatasetApi | createDataset | POST /organizations/{organization_id}/workspaces/{workspace_id}/datasets | Create a Dataset |
| DatasetApi | createDatasetAccessControl | POST /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/security/access | Add a control access to the Dataset |
| DatasetApi | createDatasetPart | POST /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/parts | Create a data part of a Dataset |
| DatasetApi | deleteDataset | DELETE /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id} | Delete a Dataset |
| DatasetApi | deleteDatasetAccessControl | DELETE /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/security/access/{identity_id} | Remove the specified access from the given Dataset |
| DatasetApi | deleteDatasetPart | DELETE /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/parts/{dataset_part_id} | Delete a Dataset part |
| DatasetApi | downloadDatasetPart | GET /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/parts/{dataset_part_id}/download | Download data from a dataset part |
| DatasetApi | getDataset | GET /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id} | Retrieve a Dataset |
| DatasetApi | getDatasetAccessControl | GET /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/security/access/{identity_id} | Get a control access for the Dataset |
| DatasetApi | getDatasetPart | GET /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/parts/{dataset_part_id} | Retrieve a data part of a Dataset |
| DatasetApi | listDatasetParts | GET /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/parts | Retrieve all dataset parts of a Dataset |
| DatasetApi | listDatasetSecurityUsers | GET /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/security/users | Get the Dataset security users list |
| DatasetApi | listDatasets | GET /organizations/{organization_id}/workspaces/{workspace_id}/datasets | Retrieve a list of defined Dataset |
| DatasetApi | queryData | GET /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/parts/{dataset_part_id}/query | Get data of a Dataset |
| DatasetApi | replaceDatasetPart | PUT /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/parts/{dataset_part_id} | Replace existing dataset parts of a Dataset |
| DatasetApi | searchDatasetParts | POST /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/parts/search | Search Dataset parts by tags |
| DatasetApi | searchDatasets | POST /organizations/{organization_id}/workspaces/{workspace_id}/datasets/search | Search Datasets by tags |
| DatasetApi | updateDataset | PATCH /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id} | Update a Dataset |
| DatasetApi | updateDatasetAccessControl | PATCH /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/security/access/{identity_id} | Update the specified access to User for a Dataset |
| DatasetApi | updateDatasetDefaultSecurity | PATCH /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/security/default | Set the Dataset default security |
| MetaApi | about | GET /about | Get various information about the API |
| OrganizationApi | createOrganization | POST /organizations | Create a new organization |
| OrganizationApi | createOrganizationAccessControl | POST /organizations/{organization_id}/security/access | Add a control access to the Organization |
| OrganizationApi | deleteOrganization | DELETE /organizations/{organization_id} | Delete an organization |
| OrganizationApi | deleteOrganizationAccessControl | DELETE /organizations/{organization_id}/security/access/{identity_id} | Remove the specified access from the given Organization |
| OrganizationApi | getOrganization | GET /organizations/{organization_id} | Get the details of an Organization |
| OrganizationApi | getOrganizationAccessControl | GET /organizations/{organization_id}/security/access/{identity_id} | Get a control access for the Organization |
| OrganizationApi | getOrganizationPermissions | GET /organizations/{organization_id}/permissions/{role} | Get the Organization permissions by given role |
| OrganizationApi | getOrganizationSecurity | GET /organizations/{organization_id}/security | Get the Organization security information |
| OrganizationApi | listOrganizationSecurityUsers | GET /organizations/{organization_id}/security/users | Get the Organization security users list |
| OrganizationApi | listOrganizations | GET /organizations | List all Organizations |
| OrganizationApi | listPermissions | GET /organizations/permissions | Get all permissions per components |
| OrganizationApi | updateOrganization | PATCH /organizations/{organization_id} | Update an Organization |
| OrganizationApi | updateOrganizationAccessControl | PATCH /organizations/{organization_id}/security/access/{identity_id} | Update the specified access to User for an Organization |
| OrganizationApi | updateOrganizationDefaultSecurity | PATCH /organizations/{organization_id}/security/default | Update the Organization default security |
| RunApi | deleteRun | DELETE /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/runs/{run_id} | Delete a run |
| RunApi | getRun | GET /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/runs/{run_id} | Get the details of a run |
| RunApi | getRunLogs | GET /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/runs/{run_id}/logs | get the logs for the Run |
| RunApi | getRunStatus | GET /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/runs/{run_id}/status | get the status for the Run |
| RunApi | listRuns | GET /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/runs | get the list of Runs for the Runner |
| RunApi | queryRunData | POST /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/runs/{run_id}/data/query | query the run data |
| RunApi | sendRunData | POST /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/runs/{run_id}/data/send | Send data associated to a run |
| RunnerApi | createRunner | POST /organizations/{organization_id}/workspaces/{workspace_id}/runners | Create a new Runner |
| RunnerApi | createRunnerAccessControl | POST /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/security/access | Add a control access to the Runner |
| RunnerApi | deleteRunner | DELETE /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id} | Delete a runner |
| RunnerApi | deleteRunnerAccessControl | DELETE /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/security/access/{identity_id} | Remove the specified access from the given Runner |
| RunnerApi | getRunner | GET /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id} | Get the details of a runner |
| RunnerApi | getRunnerAccessControl | GET /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/security/access/{identity_id} | Get a control access for the Runner |
| RunnerApi | getRunnerSecurity | GET /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/security | Get the Runner security information |
| RunnerApi | listRunnerPermissions | GET /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/permissions/{role} | Get the Runner permission by given role |
| RunnerApi | listRunnerSecurityUsers | GET /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/security/users | Get the Runner security users list |
| RunnerApi | listRunners | GET /organizations/{organization_id}/workspaces/{workspace_id}/runners | List all Runners |
| RunnerApi | startRun | POST /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/start | Start a run with runner parameters |
| RunnerApi | stopRun | POST /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/stop | Stop the last run |
| RunnerApi | updateRunner | PATCH /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id} | Update a runner |
| RunnerApi | updateRunnerAccessControl | PATCH /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/security/access/{identity_id} | Update the specified access to User for a Runner |
| RunnerApi | updateRunnerDefaultSecurity | PATCH /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/security/default | Set the Runner default security |
| SolutionApi | createSolution | POST /organizations/{organization_id}/solutions | Create a new solution |
| SolutionApi | createSolutionAccessControl | POST /organizations/{organization_id}/solutions/{solution_id}/security/access | Create solution access control |
| SolutionApi | createSolutionFile | POST /organizations/{organization_id}/solutions/{solution_id}/files | Upload a file for the Solution |
| SolutionApi | createSolutionParameter | POST /organizations/{organization_id}/solutions/{solution_id}/parameters | Create solution parameter for a solution |
| SolutionApi | createSolutionParameterGroup | POST /organizations/{organization_id}/solutions/{solution_id}/parameterGroups | Create a solution parameter group |
| SolutionApi | createSolutionRunTemplate | POST /organizations/{organization_id}/solutions/{solution_id}/runTemplates | Create a solution run template |
| SolutionApi | deleteSolution | DELETE /organizations/{organization_id}/solutions/{solution_id} | Delete a solution |
| SolutionApi | deleteSolutionAccessControl | DELETE /organizations/{organization_id}/solutions/{solution_id}/security/access/{identity_id} | Delete solution access control |
| SolutionApi | deleteSolutionFile | DELETE /organizations/{organization_id}/solutions/{solution_id}/files/delete | Delete a solution file |
| SolutionApi | deleteSolutionFiles | DELETE /organizations/{organization_id}/solutions/{solution_id}/files | Delete all Solution files |
| SolutionApi | deleteSolutionParameter | DELETE /organizations/{organization_id}/solutions/{solution_id}/parameters/{parameter_id} | Delete specific parameter from the solution |
| SolutionApi | deleteSolutionParameterGroup | DELETE /organizations/{organization_id}/solutions/{solution_id}/parameterGroups/{parameter_group_id} | Delete a parameter group from the solution |
| SolutionApi | deleteSolutionRunTemplate | DELETE /organizations/{organization_id}/solutions/{solution_id}/runTemplates/{run_template_id} | Delete a specific run template |
| SolutionApi | getRunTemplate | GET /organizations/{organization_id}/solutions/{solution_id}/runTemplates/{run_template_id} | Retrieve a solution run templates |
| SolutionApi | getSolution | GET /organizations/{organization_id}/solutions/{solution_id} | Get the details of a solution |
| SolutionApi | getSolutionAccessControl | GET /organizations/{organization_id}/solutions/{solution_id}/security/access/{identity_id} | Get solution access control |
| SolutionApi | getSolutionFile | GET /organizations/{organization_id}/solutions/{solution_id}/files/download | Download the Solution File specified |
| SolutionApi | getSolutionParameter | GET /organizations/{organization_id}/solutions/{solution_id}/parameters/{parameter_id} | Get the details of a solution parameter |
| SolutionApi | getSolutionParameterGroup | GET /organizations/{organization_id}/solutions/{solution_id}/parameterGroups/{parameter_group_id} | Get details of a solution parameter group |
| SolutionApi | getSolutionSecurity | GET /organizations/{organization_id}/solutions/{solution_id}/security | Get solution security information |
| SolutionApi | listRunTemplates | GET /organizations/{organization_id}/solutions/{solution_id}/runTemplates | List all solution run templates |
| SolutionApi | listSolutionFiles | GET /organizations/{organization_id}/solutions/{solution_id}/files | List all Solution files |
| SolutionApi | listSolutionParameterGroups | GET /organizations/{organization_id}/solutions/{solution_id}/parameterGroups | List all solution parameter groups |
| SolutionApi | listSolutionParameters | GET /organizations/{organization_id}/solutions/{solution_id}/parameters | List all solution parameters |
| SolutionApi | listSolutionSecurityUsers | GET /organizations/{organization_id}/solutions/{solution_id}/security/users | List solution security users |
| SolutionApi | listSolutions | GET /organizations/{organization_id}/solutions | List all Solutions |
| SolutionApi | updateSolution | PATCH /organizations/{organization_id}/solutions/{solution_id} | Update a solution |
| SolutionApi | updateSolutionAccessControl | PATCH /organizations/{organization_id}/solutions/{solution_id}/security/access/{identity_id} | Update solution access control |
| SolutionApi | updateSolutionDefaultSecurity | PATCH /organizations/{organization_id}/solutions/{solution_id}/security/default | Update solution default security |
| SolutionApi | updateSolutionParameter | PATCH /organizations/{organization_id}/solutions/{solution_id}/parameters/{parameter_id} | Update solution parameter |
| SolutionApi | updateSolutionParameterGroup | PATCH /organizations/{organization_id}/solutions/{solution_id}/parameterGroups/{parameter_group_id} | Update a solution parameter group |
| SolutionApi | updateSolutionRunTemplate | PATCH /organizations/{organization_id}/solutions/{solution_id}/runTemplates/{run_template_id} | Update a specific run template |
| WorkspaceApi | createWorkspace | POST /organizations/{organization_id}/workspaces | Create a new workspace |
| WorkspaceApi | createWorkspaceAccessControl | POST /organizations/{organization_id}/workspaces/{workspace_id}/security/access | Add a control access to the Workspace |
| WorkspaceApi | createWorkspaceFile | POST /organizations/{organization_id}/workspaces/{workspace_id}/files | Upload a file for the Workspace |
| WorkspaceApi | deleteWorkspace | DELETE /organizations/{organization_id}/workspaces/{workspace_id} | Delete a workspace |
| WorkspaceApi | deleteWorkspaceAccessControl | DELETE /organizations/{organization_id}/workspaces/{workspace_id}/security/access/{identity_id} | Remove the specified access from the given Workspace |
| WorkspaceApi | deleteWorkspaceFile | DELETE /organizations/{organization_id}/workspaces/{workspace_id}/files/delete | Delete a workspace file |
| WorkspaceApi | deleteWorkspaceFiles | DELETE /organizations/{organization_id}/workspaces/{workspace_id}/files | Delete all Workspace files |
| WorkspaceApi | getWorkspace | GET /organizations/{organization_id}/workspaces/{workspace_id} | Get the details of a workspace |
| WorkspaceApi | getWorkspaceAccessControl | GET /organizations/{organization_id}/workspaces/{workspace_id}/security/access/{identity_id} | Get a control access for the Workspace |
| WorkspaceApi | getWorkspaceFile | GET /organizations/{organization_id}/workspaces/{workspace_id}/files/download | Download the Workspace File specified |
| WorkspaceApi | getWorkspaceSecurity | GET /organizations/{organization_id}/workspaces/{workspace_id}/security | Get the Workspace security information |
| WorkspaceApi | listWorkspaceFiles | GET /organizations/{organization_id}/workspaces/{workspace_id}/files | List all Workspace files |
| WorkspaceApi | listWorkspaceRolePermissions | GET /organizations/{organization_id}/workspaces/{workspace_id}/permissions/{role} | Get the Workspace permission by given role |
| WorkspaceApi | listWorkspaceSecurityUsers | GET /organizations/{organization_id}/workspaces/{workspace_id}/security/users | Get the Workspace security users list |
| WorkspaceApi | listWorkspaces | GET /organizations/{organization_id}/workspaces | List all Workspaces |
| WorkspaceApi | updateWorkspace | PATCH /organizations/{organization_id}/workspaces/{workspace_id} | Update a workspace |
| WorkspaceApi | updateWorkspaceAccessControl | PATCH /organizations/{organization_id}/workspaces/{workspace_id}/security/access/{identity_id} | Update the specified access to User for a Workspace |
| WorkspaceApi | updateWorkspaceDefaultSecurity | PATCH /organizations/{organization_id}/workspaces/{workspace_id}/security/default | Update the Workspace default security |
- AboutInfo
- AboutInfoVersion
- ComponentRolePermissions
- ContainerResourceSizeInfo
- ContainerResourceSizing
- CreateInfo
- CreatedRun
- Dataset
- DatasetAccessControl
- DatasetCreateRequest
- DatasetPart
- DatasetPartCreateRequest
- DatasetPartTypeEnum
- DatasetPartUpdateRequest
- DatasetRole
- DatasetSecurity
- DatasetUpdateRequest
- EditInfo
- LastRunInfo
- Organization
- OrganizationAccessControl
- OrganizationCreateRequest
- OrganizationEditInfo
- OrganizationRole
- OrganizationSecurity
- OrganizationUpdateRequest
- QueryResult
- ResourceSizeInfo
- Run
- RunContainer
- RunData
- RunDataQuery
- RunEditInfo
- RunResourceRequested
- RunState
- RunStatus
- RunStatusNode
- RunTemplate
- RunTemplateCreateRequest
- RunTemplateParameter
- RunTemplateParameterCreateRequest
- RunTemplateParameterGroup
- RunTemplateParameterGroupCreateRequest
- RunTemplateParameterGroupUpdateRequest
- RunTemplateParameterUpdateRequest
- RunTemplateParameterValue
- RunTemplateResourceSizing
- RunTemplateUpdateRequest
- Runner
- RunnerAccessControl
- RunnerCreateRequest
- RunnerEditInfo
- RunnerResourceSizing
- RunnerRole
- RunnerRunTemplateParameterValue
- RunnerSecurity
- RunnerUpdateRequest
- RunnerValidationStatus
- SendRunDataRequest
- Solution
- SolutionAccessControl
- SolutionCreateRequest
- SolutionEditInfo
- SolutionFile
- SolutionRole
- SolutionSecurity
- SolutionUpdateRequest
- Workspace
- WorkspaceAccessControl
- WorkspaceCreateRequest
- WorkspaceEditInfo
- WorkspaceFile
- WorkspaceRole
- WorkspaceSecurity
- WorkspaceSolution
- WorkspaceUpdateRequest
- WorkspaceWebApp
Authentication schemes defined for the API:
- Type: OAuth
- Flow: accessCode
- Authorization URL: https://example.com/authorize
- Scopes: N/A