state_machine_as_a_service

StateMachineAsAService - JavaScript client for state_machine_as_a_service No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) This SDK is automatically generated by the Swagger Codegen project:

• API version: 0.3.0
• Package version: 0.3.0
• Build package: io.swagger.codegen.v3.generators.javascript.JavaScriptClientCodegen

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 state_machine_as_a_service --save

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 StateMachineAsAService = require('state_machine_as_a_service');
var defaultClient = StateMachineAsAService.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token"

var api = new StateMachineAsAService.DefaultApi()
var body = new StateMachineAsAService.StateMachineUuidAdvanceBody(); // {StateMachineUuidAdvanceBody} 
var domain = "domain_example"; // {String} 
var stateMachineUuid = "stateMachineUuid_example"; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.advanceStateMachine(body, domain, stateMachineUuid, callback);

Documentation for API Endpoints

All URIs are relative to https://devapi.statemachinez.com/statemachine/1

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- StateMachineAsAService.DefaultApi | advanceStateMachine | POST /{domain}/stateMachine/{stateMachineUuid}/advance | Advance state machine to the next state assuming the state has one edge out or multiple edges with conditions StateMachineAsAService.DefaultApi | advanceStateMachineToState | POST /{domain}/stateMachine/{stateMachineUuid}/advance/{toStateId} | Advance state machine to a specific state StateMachineAsAService.DefaultApi | finalizeStateMachine | POST /{domain}/stateMachine/{stateMachineUuid}/finalize | Finanlizes a state machine, it will not be available for operating on after finalization StateMachineAsAService.DefaultApi | getBlueprint | GET /{domain}/blueprint/{namespace}/{id}/{version} | Get StateMachine blueprint StateMachineAsAService.DefaultApi | getCurrentState | GET /{domain}/stateMachine/{stateMachineUuid}/currentState | gets the current state in the given state machine id StateMachineAsAService.DefaultApi | getCurrentStateData | GET /{domain}/stateMachine/{stateMachineUuid}/data | gets state machine instance current data StateMachineAsAService.DefaultApi | getState | GET /{domain}/stateMachine/{stateMachineUuid}/state/{stateUuid} | gets the a specific state in the state machine StateMachineAsAService.DefaultApi | getStateData | GET /{domain}/stateMachine/{stateMachineUuid}/state/{stateUuid}/data | gets the data for the given state uuid StateMachineAsAService.DefaultApi | getStateMachine | GET /{domain}/stateMachine/{stateMachineUuid} | gets state machine info StateMachineAsAService.DefaultApi | getStateMachinePath | GET /{domain}/stateMachine/{stateMachineUuid}/path | Gets the path of states leading to the current state from latest to first StateMachineAsAService.DefaultApi | getStateMachineSteps | GET /{domain}/stateMachine/{stateMachineUuid}/steps | Returns the full list of states visited during the execution of the state machine, including reverted states StateMachineAsAService.DefaultApi | healthCheck | GET / | StateMachineAsAService.DefaultApi | listBlueprints | GET /{domain}/blueprint/list | lists domain state machines blueprints StateMachineAsAService.DefaultApi | listStateMachines | GET /{domain}/stateMachine/list | lists domain state machines instances StateMachineAsAService.DefaultApi | loadBlueprint | POST /{domain}/blueprint/{namespace}/{id}/load | Load State Machine Definitions StateMachineAsAService.DefaultApi | lockStateMachine | POST /{domain}/stateMachine/{stateMachineUuid}/lock | Lock State Machine StateMachineAsAService.DefaultApi | revertStateMachine | POST /{domain}/stateMachine/{stateMachineUuid}/revert/{toStateUuid} | Revert state machine to a past state StateMachineAsAService.DefaultApi | startStateMachine | POST /{domain}/blueprint/{namespace}/{id}/{version}/start | Start a new instance of a state machine blueprint StateMachineAsAService.DefaultApi | unlockStateMachine | POST /{domain}/stateMachine/{stateMachineUuid}/unlock | StateMachineAsAService.DefaultApi | updateStateMachineData | POST /{domain}/stateMachine/{stateMachineUuid}/data/{dataOp} | Update Data for the state machine

Documentation for Models

• StateMachineAsAService.AdvanceToStateIdBody
• StateMachineAsAService.DataDataOpBody
• StateMachineAsAService.InlineResponse200
• StateMachineAsAService.InlineResponse2001
• StateMachineAsAService.InlineResponse2002
• StateMachineAsAService.RevertToStateUuidBody
• StateMachineAsAService.StateMachineUuidAdvanceBody
• StateMachineAsAService.StateMachineUuidFinalizeBody
• StateMachineAsAService.StateMachineUuidLockBody
• StateMachineAsAService.StateMachineUuidUnlockBody
• StateMachineAsAService.VersionStartBody

Documentation for Authorization

ApiKeyAuth

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