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 = '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(account_id, 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

• DocuSign_Maestro::AccessTokenResponse
• DocuSign_Maestro::AccessTokenTokenTypes
• DocuSign_Maestro::CancelResponse
• DocuSign_Maestro::CreateOrUpdateWorkflowDefinitionRequestBody
• DocuSign_Maestro::DSDoUntilStep
• DocuSign_Maestro::DSDocGenStep
• DocuSign_Maestro::DSDocGenStepInput
• DocuSign_Maestro::DSIdvStep
• DocuSign_Maestro::DSIdvStepInput
• DocuSign_Maestro::DSIfElseStep
• DocuSign_Maestro::DSLoopStep
• DocuSign_Maestro::DSParallelStep
• DocuSign_Maestro::DSServiceStep
• DocuSign_Maestro::DSSignStep
• DocuSign_Maestro::DSSignStepInput
• DocuSign_Maestro::DSTransformationStep
• DocuSign_Maestro::DSWebFormsStep
• DocuSign_Maestro::DSWebFormsStepConfig
• DocuSign_Maestro::DSWorkflowBooleanExpression
• DocuSign_Maestro::DSWorkflowComparisonExpression
• DocuSign_Maestro::DSWorkflowComparisonOperatorTypes
• DocuSign_Maestro::DSWorkflowConcatExpression
• DocuSign_Maestro::DSWorkflowDocGenDocOutputFormat
• DocuSign_Maestro::DSWorkflowExpressionTypesBooleanExpression
• DocuSign_Maestro::DSWorkflowExpressionTypesComparisonExpression
• DocuSign_Maestro::DSWorkflowExpressionTypesParallelExpression
• DocuSign_Maestro::DSWorkflowIndexOfExpression
• DocuSign_Maestro::DSWorkflowLane
• DocuSign_Maestro::DSWorkflowLanesRecord
• DocuSign_Maestro::DSWorkflowLastIndexOfExpression
• DocuSign_Maestro::DSWorkflowLogicalOperatorTypes
• DocuSign_Maestro::DSWorkflowParallelExpression
• DocuSign_Maestro::DSWorkflowParticipantRecord
• DocuSign_Maestro::DSWorkflowReplaceExpression
• DocuSign_Maestro::DSWorkflowStep
• DocuSign_Maestro::DSWorkflowStepTypesDSDocGen
• DocuSign_Maestro::DSWorkflowStepTypesDSIdv
• DocuSign_Maestro::DSWorkflowStepTypesDSIfElse
• DocuSign_Maestro::DSWorkflowStepTypesDSSign
• DocuSign_Maestro::DSWorkflowStepTypesDSTransformation
• DocuSign_Maestro::DSWorkflowStepTypesDSWebForms
• DocuSign_Maestro::DSWorkflowStepTypesDoUntil
• DocuSign_Maestro::DSWorkflowStepTypesLoop
• DocuSign_Maestro::DSWorkflowStepTypesParallel
• DocuSign_Maestro::DSWorkflowSubstringExpression
• DocuSign_Maestro::DSWorkflowToLowerExpression
• DocuSign_Maestro::DSWorkflowToUpperExpression
• DocuSign_Maestro::DSWorkflowTransformationExpression
• DocuSign_Maestro::DSWorkflowTransformationExpressionTypesConcatExpression
• DocuSign_Maestro::DSWorkflowTransformationExpressionTypesIndexOfExpression
• DocuSign_Maestro::DSWorkflowTransformationExpressionTypesLastIndexOfExpression
• DocuSign_Maestro::DSWorkflowTransformationExpressionTypesReplaceExpression
• DocuSign_Maestro::DSWorkflowTransformationExpressionTypesSubstringExpression
• DocuSign_Maestro::DSWorkflowTransformationExpressionTypesToLowerExpression
• DocuSign_Maestro::DSWorkflowTransformationExpressionTypesToUpperExpression
• DocuSign_Maestro::DSWorkflowTrigger
• DocuSign_Maestro::DSWorkflowTriggerTypes
• DocuSign_Maestro::DSWorkflowVariable
• DocuSign_Maestro::DSWorkflowVariableFromParticipant
• DocuSign_Maestro::DSWorkflowVariableFromStep
• DocuSign_Maestro::DSWorkflowVariableFromVariable
• DocuSign_Maestro::DSWorkflowVariableRecord
• DocuSign_Maestro::DSWorkflowVariableSourceTypesStep
• DocuSign_Maestro::DSWorkflowVariableSourceTypesVariable
• DocuSign_Maestro::DeployRequest
• DocuSign_Maestro::DeployResponse
• DocuSign_Maestro::DeployStatus
• DocuSign_Maestro::DeploymentStatus
• DocuSign_Maestro::ESignDocumentFromESignTemplate
• DocuSign_Maestro::ESignDocumentFromPreviousStep
• DocuSign_Maestro::ESignDocumentTypesFromDSTemplate
• DocuSign_Maestro::ESignDocumentTypesFromPreviousStep
• DocuSign_Maestro::ESignDocuments
• DocuSign_Maestro::ESignLocalePolicy
• DocuSign_Maestro::ESignSigner
• DocuSign_Maestro::ESignTabs
• DocuSign_Maestro::ESignTabsRecord
• DocuSign_Maestro::ErrorCodes
• DocuSign_Maestro::ErrorResponse
• DocuSign_Maestro::EventTypes
• DocuSign_Maestro::GetConfigurationInstanceResponse
• DocuSign_Maestro::GetConfigurationInstancesResponse
• DocuSign_Maestro::GetConfigurationInstancesResponseConfigInstances
• DocuSign_Maestro::HttpTypes
• DocuSign_Maestro::InvalidWorkflowResponse
• DocuSign_Maestro::NewOrUpdatedWorkflowDefinitionResponse
• DocuSign_Maestro::NumberOrVariable
• DocuSign_Maestro::Participant
• DocuSign_Maestro::ProgressInstance
• DocuSign_Maestro::RecordStringBoolean
• DocuSign_Maestro::RecordStringOrVariableOrTransformation
• DocuSign_Maestro::RecordToNever
• DocuSign_Maestro::ReplicationStatus
• DocuSign_Maestro::StartedByInstance
• DocuSign_Maestro::StringOrVariableOrTransformation
• DocuSign_Maestro::SuccessMessageResponse
• DocuSign_Maestro::TriggerPayload
• DocuSign_Maestro::TriggerWorkflowViaPostResponse
• DocuSign_Maestro::ValidationErrors
• DocuSign_Maestro::WorkflowDefinition
• DocuSign_Maestro::WorkflowDefinitionList
• DocuSign_Maestro::WorkflowDefinitionMetadata
• DocuSign_Maestro::WorkflowDefinitionWithId
• DocuSign_Maestro::WorkflowDeleteResponse
• DocuSign_Maestro::WorkflowInstance
• DocuSign_Maestro::WorkflowInstanceMap
• DocuSign_Maestro::WorkflowInstanceState
• DocuSign_Maestro::WorkflowInstancesList
• DocuSign_Maestro::WorkflowMetadataStatus
• DocuSign_Maestro::WorkflowStepError
• DocuSign_Maestro::WorkflowStepErrorError
• DocuSign_Maestro::WorkflowStepHistory
• DocuSign_Maestro::WorkflowStepHistoryList
• DocuSign_Maestro::WorkflowStepHistoryState

Documentation for Authorization

docusignAccessCode

• Type: OAuth
• Flow: accessCode
• Authorization URL: https://account.docusign.com/oauth/auth
• Scopes: N/A