@cosmotech/api v3.0.10-private

@cosmotech/api

CosmotechApi - JavaScript client for @cosmotech/api Cosmo Tech Platform API This SDK is automatically generated by the OpenAPI Generator project:

• API version: 3.0.10-private
• Package version: 3.0.10-private
• Build package: org.openapitools.codegen.languages.JavascriptClientCodegen For more information, please visit https://github.com/Cosmo-Tech/cosmotech-api

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install @cosmotech/api --save

Finally, you need to build the module:

npm run build

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

To use the link you just defined in your project, switch to the directory you want to use your @cosmotech/api from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

If the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var CosmotechApi = require('@cosmotech/api');

var defaultClient = CosmotechApi.ApiClient.instance;
// Configure OAuth2 access token for authorization: oAuth2AuthCode
var oAuth2AuthCode = defaultClient.authentications['oAuth2AuthCode'];
oAuth2AuthCode.accessToken = "YOUR ACCESS TOKEN"

var api = new CosmotechApi.ConnectorApi()
var opts = {
  'page': 56, // {Number} page number to query
  'size': 56 // {Number} amount of result by page
};
api.findAllConnectors(opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Documentation for API Endpoints

All URIs are relative to https://dev.api.cosmotech.com

Documentation for Models

• CosmotechApi.ComponentRolePermissions
• CosmotechApi.Connector
• CosmotechApi.ConnectorParameter
• CosmotechApi.ConnectorParameterGroup
• CosmotechApi.ContainerResourceSizeInfo
• CosmotechApi.ContainerResourceSizing
• CosmotechApi.Dataset
• CosmotechApi.DatasetAccessControl
• CosmotechApi.DatasetCompatibility
• CosmotechApi.DatasetConnector
• CosmotechApi.DatasetCopyParameters
• CosmotechApi.DatasetRole
• CosmotechApi.DatasetSearch
• CosmotechApi.DatasetSecurity
• CosmotechApi.DatasetSourceType
• CosmotechApi.DatasetTwinGraphHash
• CosmotechApi.DatasetTwinGraphInfo
• CosmotechApi.DatasetTwinGraphQuery
• CosmotechApi.DeleteHistoricalData
• CosmotechApi.GraphProperties
• CosmotechApi.Organization
• CosmotechApi.OrganizationAccessControl
• CosmotechApi.OrganizationRole
• CosmotechApi.OrganizationSecurity
• CosmotechApi.OrganizationService
• CosmotechApi.OrganizationServices
• CosmotechApi.ResourceSizeInfo
• CosmotechApi.RunTemplate
• CosmotechApi.RunTemplateHandlerId
• CosmotechApi.RunTemplateOrchestrator
• CosmotechApi.RunTemplateParameter
• CosmotechApi.RunTemplateParameterGroup
• CosmotechApi.RunTemplateParameterValue
• CosmotechApi.RunTemplateResourceSizing
• CosmotechApi.RunTemplateStepSource
• CosmotechApi.Scenario
• CosmotechApi.ScenarioAccessControl
• CosmotechApi.ScenarioChangedParameterValue
• CosmotechApi.ScenarioComparisonResult
• CosmotechApi.ScenarioDataDownloadInfo
• CosmotechApi.ScenarioDataDownloadJob
• CosmotechApi.ScenarioJobState
• CosmotechApi.ScenarioLastRun
• CosmotechApi.ScenarioResourceSizing
• CosmotechApi.ScenarioRole
• CosmotechApi.ScenarioRun
• CosmotechApi.ScenarioRunContainer
• CosmotechApi.ScenarioRunContainerArtifact
• CosmotechApi.ScenarioRunContainerLogs
• CosmotechApi.ScenarioRunLogs
• CosmotechApi.ScenarioRunResourceRequested
• CosmotechApi.ScenarioRunResult
• CosmotechApi.ScenarioRunSearch
• CosmotechApi.ScenarioRunStartContainers
• CosmotechApi.ScenarioRunState
• CosmotechApi.ScenarioRunStatus
• CosmotechApi.ScenarioRunStatusNode
• CosmotechApi.ScenarioRunTemplateParameterValue
• CosmotechApi.ScenarioSecurity
• CosmotechApi.ScenarioValidationStatus
• CosmotechApi.Solution
• CosmotechApi.SolutionAccessControl
• CosmotechApi.SolutionRole
• CosmotechApi.SolutionSecurity
• CosmotechApi.SourceInfo
• CosmotechApi.SubDatasetGraphQuery
• CosmotechApi.TwinGraphBatchResult
• CosmotechApi.TwinGraphHash
• CosmotechApi.TwinGraphQuery
• CosmotechApi.Validator
• CosmotechApi.ValidatorRun
• CosmotechApi.Workspace
• CosmotechApi.WorkspaceAccessControl
• CosmotechApi.WorkspaceFile
• CosmotechApi.WorkspaceRole
• CosmotechApi.WorkspaceSecret
• CosmotechApi.WorkspaceSecurity
• CosmotechApi.WorkspaceSolution
• CosmotechApi.WorkspaceWebApp

Documentation for Authorization

oAuth2AuthCode

• Type: OAuth
• Flow: implicit
• Authorization URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
• Scopes:
  • http://dev.api.cosmotech.com/platform: Platform scope