docusign_maestro

DocuSign_Maestro - the Ruby gem for the Maestro API

Maestro authors and executes experiences that allow non-coders the ability to define Simple Business Process without having to write code and to deploy them seamlessly without having to have development expertise

This SDK is automatically generated by the Swagger Codegen project:

  • API version: 1.0.0
  • Package version: 1.0.0
  • Build package: io.swagger.codegen.languages.RubyClientCodegen For more information, please visit https://developers.docusign.com/

Installation

Build a gem

To build the Ruby code into a gem:

gem build docusign_maestro.gemspec

Then either install the gem locally:

gem install ./docusign_maestro-1.0.0.gem

(for development, run gem install --dev ./docusign_maestro-1.0.0.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'docusign_maestro', '~> 1.0.0'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:

gem 'docusign_maestro', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'docusign_maestro'

# Setup authorization
DocuSign_Maestro.configure do |config|
  # Configure OAuth2 access token for authorization: docusignAccessCode
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = DocuSign_Maestro::WorkflowInstanceManagementApi.new

 = 'account_id_example' # String | Account ID

instance_id = 'instance_id_example' # String | DS Workflow Instance Id (dacId)


begin
  #Cancels a running workflow instance.
  result = api_instance.cancel_workflow_instance(, instance_id)
  p result
rescue DocuSign_Maestro::ApiError => e
  puts "Exception when calling WorkflowInstanceManagementApi->cancel_workflow_instance: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://www.docusign.net

Class Method HTTP request Description
DocuSign_Maestro::WorkflowInstanceManagementApi cancel_workflow_instance POST aow-manage/v1.0/management/accounts/accountId/instances/instanceId/cancel Cancels a running workflow instance.
DocuSign_Maestro::WorkflowInstanceManagementApi get_workflow_history GET aow-manage/v1.0/management/accounts/accountId/instances/instanceId/history Get List of Step Histories
DocuSign_Maestro::WorkflowInstanceManagementApi get_workflow_instance GET aow-manage/v1.0/management/accounts/accountId/workflowDefinitions/workflowDefinitionId/instances/instanceId Get Workflow Instance Details
DocuSign_Maestro::WorkflowInstanceManagementApi get_workflow_instances GET aow-manage/v1.0/management/accounts/accountId/workflowDefinitions/workflowDefinitionId/instances Get List of Workflow Instances
DocuSign_Maestro::WorkflowManagementApi create_workflow_definition POST aow-manage/v1.0/management/accounts/accountId/workflowDefinitions Creates a new workflow definition.
DocuSign_Maestro::WorkflowManagementApi delete_workflow_definition DELETE aow-manage/v1.0/management/accounts/accountId/workflowDefinitions/workflowDefinitionId Deletes a workflow definition.
DocuSign_Maestro::WorkflowManagementApi get_workflow_definition GET aow-manage/v1.0/management/accounts/accountId/workflowDefinitions/workflowDefinitionId Get Workflow Definition
DocuSign_Maestro::WorkflowManagementApi get_workflow_definition_config_instances GET aow-manage/v1.0/management/accounts/accountId/workflowDefinitions/workflowDefinitionId/configInstances Gets configuration instances
DocuSign_Maestro::WorkflowManagementApi get_workflow_definitions GET aow-manage/v1.0/management/accounts/accountId/workflowDefinitions Get Workflow Definitions metadata
DocuSign_Maestro::WorkflowManagementApi publish_or_un_publish_workflow_definition POST aow-manage/v1.0/management/accounts/accountId/workflowDefinitions/workflowDefinitionId/publish Publishes or unpublishes a workflow definition.
DocuSign_Maestro::WorkflowManagementApi update_workflow_definition PUT aow-manage/v1.0/management/accounts/accountId/workflowDefinitions/workflowDefinitionId Updates a workflow definition.
DocuSign_Maestro::WorkflowTriggerApi trigger_workflow POST aow-auth/v1.0/accounts/accountId/workflows/trigger Creates a new workflow instance after authenticating with DS Account Server

Documentation for Models

Documentation for Authorization

docusignAccessCode