docusign_maestro 1.0.0.rc1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/CHANGELOG.md +35 -0
- data/README.md +230 -0
- data/docusign_maestro.gemspec +48 -0
- data/lib/docusign_maestro/api/workflow_instance_management_api.rb +248 -0
- data/lib/docusign_maestro/api/workflow_management_api.rb +440 -0
- data/lib/docusign_maestro/api/workflow_trigger_api.rb +95 -0
- data/lib/docusign_maestro/client/api_client.rb +600 -0
- data/lib/docusign_maestro/client/api_error.rb +37 -0
- data/lib/docusign_maestro/client/auth/oauth.rb +1061 -0
- data/lib/docusign_maestro/configuration.rb +203 -0
- data/lib/docusign_maestro/models/access_token_response.rb +204 -0
- data/lib/docusign_maestro/models/access_token_token_types.rb +30 -0
- data/lib/docusign_maestro/models/account_id.rb +175 -0
- data/lib/docusign_maestro/models/aow_uuid.rb +174 -0
- data/lib/docusign_maestro/models/aow_uuid_string.rb +174 -0
- data/lib/docusign_maestro/models/cancel_response.rb +197 -0
- data/lib/docusign_maestro/models/create_or_update_workflow_definition_request_body.rb +184 -0
- data/lib/docusign_maestro/models/deploy_request.rb +188 -0
- data/lib/docusign_maestro/models/deploy_response.rb +220 -0
- data/lib/docusign_maestro/models/deploy_status.rb +30 -0
- data/lib/docusign_maestro/models/deployment_status.rb +33 -0
- data/lib/docusign_maestro/models/ds_do_until_step.rb +247 -0
- data/lib/docusign_maestro/models/ds_doc_gen_step.rb +261 -0
- data/lib/docusign_maestro/models/ds_doc_gen_step_input.rb +246 -0
- data/lib/docusign_maestro/models/ds_idv_step.rb +261 -0
- data/lib/docusign_maestro/models/ds_idv_step_input.rb +234 -0
- data/lib/docusign_maestro/models/ds_if_else_step.rb +264 -0
- data/lib/docusign_maestro/models/ds_loop_step.rb +247 -0
- data/lib/docusign_maestro/models/ds_parallel_step.rb +246 -0
- data/lib/docusign_maestro/models/ds_service_step.rb +175 -0
- data/lib/docusign_maestro/models/ds_sign_step.rb +261 -0
- data/lib/docusign_maestro/models/ds_sign_step_input.rb +241 -0
- data/lib/docusign_maestro/models/ds_step_id.rb +175 -0
- data/lib/docusign_maestro/models/ds_transformation_step.rb +279 -0
- data/lib/docusign_maestro/models/ds_web_forms_step.rb +265 -0
- data/lib/docusign_maestro/models/ds_web_forms_step_config.rb +188 -0
- data/lib/docusign_maestro/models/ds_workflow_boolean_expression.rb +219 -0
- data/lib/docusign_maestro/models/ds_workflow_comparison_expression.rb +232 -0
- data/lib/docusign_maestro/models/ds_workflow_comparison_operator_types.rb +39 -0
- data/lib/docusign_maestro/models/ds_workflow_concat_expression.rb +200 -0
- data/lib/docusign_maestro/models/ds_workflow_doc_gen_doc_output_format.rb +29 -0
- data/lib/docusign_maestro/models/ds_workflow_expression_types_boolean_expression.rb +28 -0
- data/lib/docusign_maestro/models/ds_workflow_expression_types_comparison_expression.rb +28 -0
- data/lib/docusign_maestro/models/ds_workflow_expression_types_parallel_expression.rb +28 -0
- data/lib/docusign_maestro/models/ds_workflow_index_of_expression.rb +218 -0
- data/lib/docusign_maestro/models/ds_workflow_lane.rb +205 -0
- data/lib/docusign_maestro/models/ds_workflow_lanes_record.rb +174 -0
- data/lib/docusign_maestro/models/ds_workflow_last_index_of_expression.rb +218 -0
- data/lib/docusign_maestro/models/ds_workflow_logical_operator_types.rb +29 -0
- data/lib/docusign_maestro/models/ds_workflow_parallel_expression.rb +204 -0
- data/lib/docusign_maestro/models/ds_workflow_participant_record.rb +175 -0
- data/lib/docusign_maestro/models/ds_workflow_replace_expression.rb +233 -0
- data/lib/docusign_maestro/models/ds_workflow_step.rb +175 -0
- data/lib/docusign_maestro/models/ds_workflow_step_types_do_until.rb +28 -0
- data/lib/docusign_maestro/models/ds_workflow_step_types_ds_doc_gen.rb +28 -0
- data/lib/docusign_maestro/models/ds_workflow_step_types_ds_idv.rb +28 -0
- data/lib/docusign_maestro/models/ds_workflow_step_types_ds_if_else.rb +28 -0
- data/lib/docusign_maestro/models/ds_workflow_step_types_ds_sign.rb +28 -0
- data/lib/docusign_maestro/models/ds_workflow_step_types_ds_transformation.rb +28 -0
- data/lib/docusign_maestro/models/ds_workflow_step_types_ds_web_forms.rb +28 -0
- data/lib/docusign_maestro/models/ds_workflow_step_types_loop.rb +28 -0
- data/lib/docusign_maestro/models/ds_workflow_step_types_parallel.rb +28 -0
- data/lib/docusign_maestro/models/ds_workflow_substring_expression.rb +228 -0
- data/lib/docusign_maestro/models/ds_workflow_to_lower_expression.rb +203 -0
- data/lib/docusign_maestro/models/ds_workflow_to_upper_expression.rb +203 -0
- data/lib/docusign_maestro/models/ds_workflow_transformation_expression.rb +175 -0
- data/lib/docusign_maestro/models/ds_workflow_transformation_expression_types_concat_expression.rb +28 -0
- data/lib/docusign_maestro/models/ds_workflow_transformation_expression_types_index_of_expression.rb +28 -0
- data/lib/docusign_maestro/models/ds_workflow_transformation_expression_types_last_index_of_expression.rb +28 -0
- data/lib/docusign_maestro/models/ds_workflow_transformation_expression_types_replace_expression.rb +28 -0
- data/lib/docusign_maestro/models/ds_workflow_transformation_expression_types_substring_expression.rb +28 -0
- data/lib/docusign_maestro/models/ds_workflow_transformation_expression_types_to_lower_expression.rb +28 -0
- data/lib/docusign_maestro/models/ds_workflow_transformation_expression_types_to_upper_expression.rb +28 -0
- data/lib/docusign_maestro/models/ds_workflow_trigger.rb +274 -0
- data/lib/docusign_maestro/models/ds_workflow_trigger_types.rb +29 -0
- data/lib/docusign_maestro/models/ds_workflow_variable.rb +175 -0
- data/lib/docusign_maestro/models/ds_workflow_variable_from_participant.rb +217 -0
- data/lib/docusign_maestro/models/ds_workflow_variable_from_step.rb +231 -0
- data/lib/docusign_maestro/models/ds_workflow_variable_from_variable.rb +231 -0
- data/lib/docusign_maestro/models/ds_workflow_variable_record.rb +175 -0
- data/lib/docusign_maestro/models/ds_workflow_variable_source_types_participant.rb +28 -0
- data/lib/docusign_maestro/models/ds_workflow_variable_source_types_step.rb +28 -0
- data/lib/docusign_maestro/models/ds_workflow_variable_source_types_variable.rb +28 -0
- data/lib/docusign_maestro/models/e_sign_document_from_e_sign_template.rb +231 -0
- data/lib/docusign_maestro/models/e_sign_document_from_previous_step.rb +232 -0
- data/lib/docusign_maestro/models/e_sign_document_types_from_ds_template.rb +28 -0
- data/lib/docusign_maestro/models/e_sign_document_types_from_previous_step.rb +28 -0
- data/lib/docusign_maestro/models/e_sign_documents.rb +175 -0
- data/lib/docusign_maestro/models/e_sign_locale_policy.rb +174 -0
- data/lib/docusign_maestro/models/e_sign_signer.rb +247 -0
- data/lib/docusign_maestro/models/e_sign_tabs.rb +416 -0
- data/lib/docusign_maestro/models/e_sign_tabs_record.rb +251 -0
- data/lib/docusign_maestro/models/error_codes.rb +44 -0
- data/lib/docusign_maestro/models/error_response.rb +193 -0
- data/lib/docusign_maestro/models/event_types.rb +31 -0
- data/lib/docusign_maestro/models/get_configuration_instance_response.rb +201 -0
- data/lib/docusign_maestro/models/get_configuration_instances_response.rb +203 -0
- data/lib/docusign_maestro/models/get_configuration_instances_response_config_instances.rb +192 -0
- data/lib/docusign_maestro/models/http_types.rb +31 -0
- data/lib/docusign_maestro/models/invalid_workflow_response.rb +204 -0
- data/lib/docusign_maestro/models/last_deployed_id.rb +174 -0
- data/lib/docusign_maestro/models/new_or_updated_workflow_definition_response.rb +232 -0
- data/lib/docusign_maestro/models/number_or_variable.rb +175 -0
- data/lib/docusign_maestro/models/participant.rb +231 -0
- data/lib/docusign_maestro/models/participant_keys.rb +30 -0
- data/lib/docusign_maestro/models/progress_instance.rb +205 -0
- data/lib/docusign_maestro/models/record_string_boolean.rb +174 -0
- data/lib/docusign_maestro/models/record_string_or_variable_or_transformation.rb +175 -0
- data/lib/docusign_maestro/models/record_to_never.rb +174 -0
- data/lib/docusign_maestro/models/replication_status.rb +37 -0
- data/lib/docusign_maestro/models/started_by_instance.rb +237 -0
- data/lib/docusign_maestro/models/string_or_variable_or_transformation.rb +175 -0
- data/lib/docusign_maestro/models/success_message_response.rb +184 -0
- data/lib/docusign_maestro/models/template_id.rb +175 -0
- data/lib/docusign_maestro/models/trigger_payload.rb +211 -0
- data/lib/docusign_maestro/models/trigger_workflow_via_post_response.rb +194 -0
- data/lib/docusign_maestro/models/user_id.rb +175 -0
- data/lib/docusign_maestro/models/validation_errors.rb +202 -0
- data/lib/docusign_maestro/models/version_string.rb +174 -0
- data/lib/docusign_maestro/models/workflow_creator_id.rb +175 -0
- data/lib/docusign_maestro/models/workflow_date_time.rb +174 -0
- data/lib/docusign_maestro/models/workflow_definition.rb +315 -0
- data/lib/docusign_maestro/models/workflow_definition_list.rb +197 -0
- data/lib/docusign_maestro/models/workflow_definition_metadata.rb +272 -0
- data/lib/docusign_maestro/models/workflow_definition_with_id.rb +292 -0
- data/lib/docusign_maestro/models/workflow_delete_response.rb +202 -0
- data/lib/docusign_maestro/models/workflow_instance.rb +304 -0
- data/lib/docusign_maestro/models/workflow_instance_id.rb +175 -0
- data/lib/docusign_maestro/models/workflow_instance_map.rb +174 -0
- data/lib/docusign_maestro/models/workflow_instance_state.rb +30 -0
- data/lib/docusign_maestro/models/workflow_instances_list.rb +175 -0
- data/lib/docusign_maestro/models/workflow_metadata_status.rb +33 -0
- data/lib/docusign_maestro/models/workflow_step_error.rb +224 -0
- data/lib/docusign_maestro/models/workflow_step_error_error.rb +194 -0
- data/lib/docusign_maestro/models/workflow_step_history.rb +298 -0
- data/lib/docusign_maestro/models/workflow_step_history_list.rb +175 -0
- data/lib/docusign_maestro/models/workflow_step_history_state.rb +30 -0
- data/lib/docusign_maestro/version.rb +14 -0
- data/lib/docusign_maestro.rb +160 -0
- data/runLinter.sh +1 -0
- metadata +446 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: d9035d9f146882286b74ed5992b864d94ed78b3b5dcad1b18a9b4ea22a8f0da9
|
4
|
+
data.tar.gz: 5e57a66947767308631d332625b564b2f91a710a7a12543a33acc7a95ad53c0c
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 9fb9036d4c322cfb76a3da0a16db6ab7a1a062ba31561074661cc738babdc9a9183b22326a99cbd7bc51c8ecdda247e3c866012b6188b59ae62e94bcece03885
|
7
|
+
data.tar.gz: feec8ac16f8e8deafd7f100542a6c0db6f1d70358f2a6a8aa71f15e4a90184e6eb95de5f717d9e128d4a272a249db24f5095614cc72b991346e0894ddb8f6697
|
data/CHANGELOG.md
ADDED
@@ -0,0 +1,35 @@
|
|
1
|
+
## [v1.0.0.rc1] - Maestro API v1.0.0-1.0.3 - 2024-04-03
|
2
|
+
### Changed
|
3
|
+
- Added support for version v1.0.0-1.0.3 of the DocuSign Maestro API.
|
4
|
+
- Updated the SDK release version.
|
5
|
+
|
6
|
+
## [v1.0.1.rc1] - Maestro API v1.0.0-1.0.1 - 2024-01-29
|
7
|
+
### Changed
|
8
|
+
- Added support for version v1.0.0-1.0.1 of the DocuSign Maestro API.
|
9
|
+
- Updated the SDK release version.
|
10
|
+
|
11
|
+
## [v1.0.0.rc6] - Maestro API v1.0.0-1.0.0 - 2024-01-05
|
12
|
+
### Changed
|
13
|
+
- Added support for version v1.0.0-1.0.0 of the DocuSign Maestro API.
|
14
|
+
- Updated the SDK release version.
|
15
|
+
|
16
|
+
## [v1.0.0.rc5] - Maestro API v1.0.0-1.0.0 - 2024-01-04
|
17
|
+
### Changed
|
18
|
+
- Added support for version v1.0.0-1.0.0 of the DocuSign Maestro API.
|
19
|
+
- Updated the SDK release version.
|
20
|
+
|
21
|
+
## [v1.0.0.rc4] - Maestro API v1.0.0-1.0.0 - 2024-01-04
|
22
|
+
### Changed
|
23
|
+
- Added support for version v1.0.0-1.0.0 of the DocuSign Maestro API.
|
24
|
+
- Updated the SDK release version.
|
25
|
+
|
26
|
+
## [v1.0.0.rc03] - Maestro API v1.0.0-1.0.0 - 2023-12-19
|
27
|
+
### Changed
|
28
|
+
- Added support for version v1.0.0-1.0.0 of the DocuSign Maestro API.
|
29
|
+
- Updated the SDK release version.
|
30
|
+
|
31
|
+
## [v1.0.0.rc02] - Maestro API 1.0.0-1.0.0 - 2023-12-15
|
32
|
+
### Changed
|
33
|
+
- Added support for version 1.0.0-1.0.0 of the DocuSign Maestro API.
|
34
|
+
- Updated the SDK release version.
|
35
|
+
|
data/README.md
ADDED
@@ -0,0 +1,230 @@
|
|
1
|
+
# docusign_maestro
|
2
|
+
|
3
|
+
DocuSign_Maestro - the Ruby gem for the Maestro API
|
4
|
+
|
5
|
+
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
|
6
|
+
|
7
|
+
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
|
8
|
+
|
9
|
+
- API version: 1.0.0
|
10
|
+
- Package version: 1.0.0.rc1
|
11
|
+
- Build package: io.swagger.codegen.languages.RubyClientCodegen
|
12
|
+
For more information, please visit [https://developers.docusign.com/](https://developers.docusign.com/)
|
13
|
+
|
14
|
+
## Installation
|
15
|
+
|
16
|
+
### Build a gem
|
17
|
+
|
18
|
+
To build the Ruby code into a gem:
|
19
|
+
|
20
|
+
```shell
|
21
|
+
gem build docusign_maestro.gemspec
|
22
|
+
```
|
23
|
+
|
24
|
+
Then either install the gem locally:
|
25
|
+
|
26
|
+
```shell
|
27
|
+
gem install ./docusign_maestro-1.0.0.rc1.gem
|
28
|
+
```
|
29
|
+
(for development, run `gem install --dev ./docusign_maestro-1.0.0.rc1.gem` to install the development dependencies)
|
30
|
+
|
31
|
+
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
32
|
+
|
33
|
+
Finally add this to the Gemfile:
|
34
|
+
|
35
|
+
gem 'docusign_maestro', '~> 1.0.0.rc1'
|
36
|
+
|
37
|
+
### Install from Git
|
38
|
+
|
39
|
+
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:
|
40
|
+
|
41
|
+
gem 'docusign_maestro', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
|
42
|
+
|
43
|
+
### Include the Ruby code directly
|
44
|
+
|
45
|
+
Include the Ruby code directly using `-I` as follows:
|
46
|
+
|
47
|
+
```shell
|
48
|
+
ruby -Ilib script.rb
|
49
|
+
```
|
50
|
+
|
51
|
+
## Getting Started
|
52
|
+
|
53
|
+
Please follow the [installation](#installation) procedure and then run the following code:
|
54
|
+
```ruby
|
55
|
+
# Load the gem
|
56
|
+
require 'docusign_maestro'
|
57
|
+
|
58
|
+
# Setup authorization
|
59
|
+
DocuSign_Maestro.configure do |config|
|
60
|
+
# Configure OAuth2 access token for authorization: docusignAccessCode
|
61
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
62
|
+
end
|
63
|
+
|
64
|
+
api_instance = DocuSign_Maestro::WorkflowInstanceManagementApi.new
|
65
|
+
|
66
|
+
account_id = 'account_id_example' # String | Account ID
|
67
|
+
|
68
|
+
instance_id = 'instance_id_example' # String | DS Workflow Instance Id (dacId)
|
69
|
+
|
70
|
+
|
71
|
+
begin
|
72
|
+
#Cancels a running workflow instance.
|
73
|
+
result = api_instance.cancel_workflow_instance(account_id, instance_id)
|
74
|
+
p result
|
75
|
+
rescue DocuSign_Maestro::ApiError => e
|
76
|
+
puts "Exception when calling WorkflowInstanceManagementApi->cancel_workflow_instance: #{e}"
|
77
|
+
end
|
78
|
+
|
79
|
+
```
|
80
|
+
|
81
|
+
## Documentation for API Endpoints
|
82
|
+
|
83
|
+
All URIs are relative to *https://www.docusign.net*
|
84
|
+
|
85
|
+
Class | Method | HTTP request | Description
|
86
|
+
------------ | ------------- | ------------- | -------------
|
87
|
+
*DocuSign_Maestro::WorkflowInstanceManagementApi* | [**cancel_workflow_instance**](docs/WorkflowInstanceManagementApi.md#cancel_workflow_instance) | **POST** aow-manage/v1.0/management/accounts/{accountId}/instances/{instanceId}/cancel | Cancels a running workflow instance.
|
88
|
+
*DocuSign_Maestro::WorkflowInstanceManagementApi* | [**get_workflow_history**](docs/WorkflowInstanceManagementApi.md#get_workflow_history) | **GET** aow-manage/v1.0/management/accounts/{accountId}/instances/{instanceId}/history | Get List of Step Histories
|
89
|
+
*DocuSign_Maestro::WorkflowInstanceManagementApi* | [**get_workflow_instance**](docs/WorkflowInstanceManagementApi.md#get_workflow_instance) | **GET** aow-manage/v1.0/management/accounts/{accountId}/workflowDefinitions/{workflowDefinitionId}/instances/{instanceId} | Get Workflow Instance Details
|
90
|
+
*DocuSign_Maestro::WorkflowInstanceManagementApi* | [**get_workflow_instances**](docs/WorkflowInstanceManagementApi.md#get_workflow_instances) | **GET** aow-manage/v1.0/management/accounts/{accountId}/workflowDefinitions/{workflowDefinitionId}/instances | Get List of Workflow Instances
|
91
|
+
*DocuSign_Maestro::WorkflowManagementApi* | [**create_workflow_definition**](docs/WorkflowManagementApi.md#create_workflow_definition) | **POST** aow-manage/v1.0/management/accounts/{accountId}/workflowDefinitions | Creates a new workflow definition.
|
92
|
+
*DocuSign_Maestro::WorkflowManagementApi* | [**delete_workflow_definition**](docs/WorkflowManagementApi.md#delete_workflow_definition) | **DELETE** aow-manage/v1.0/management/accounts/{accountId}/workflowDefinitions/{workflowDefinitionId} | Deletes a workflow definition.
|
93
|
+
*DocuSign_Maestro::WorkflowManagementApi* | [**get_workflow_definition**](docs/WorkflowManagementApi.md#get_workflow_definition) | **GET** aow-manage/v1.0/management/accounts/{accountId}/workflowDefinitions/{workflowDefinitionId} | Get Workflow Definition
|
94
|
+
*DocuSign_Maestro::WorkflowManagementApi* | [**get_workflow_definition_config_instances**](docs/WorkflowManagementApi.md#get_workflow_definition_config_instances) | **GET** aow-manage/v1.0/management/accounts/{accountId}/workflowDefinitions/{workflowDefinitionId}/configInstances | Gets configuration instances
|
95
|
+
*DocuSign_Maestro::WorkflowManagementApi* | [**get_workflow_definitions**](docs/WorkflowManagementApi.md#get_workflow_definitions) | **GET** aow-manage/v1.0/management/accounts/{accountId}/workflowDefinitions | Get Workflow Definitions metadata
|
96
|
+
*DocuSign_Maestro::WorkflowManagementApi* | [**publish_or_un_publish_workflow_definition**](docs/WorkflowManagementApi.md#publish_or_un_publish_workflow_definition) | **POST** aow-manage/v1.0/management/accounts/{accountId}/workflowDefinitions/{workflowDefinitionId}/publish | Publishes or unpublishes a workflow definition.
|
97
|
+
*DocuSign_Maestro::WorkflowManagementApi* | [**update_workflow_definition**](docs/WorkflowManagementApi.md#update_workflow_definition) | **PUT** aow-manage/v1.0/management/accounts/{accountId}/workflowDefinitions/{workflowDefinitionId} | Updates a workflow definition.
|
98
|
+
*DocuSign_Maestro::WorkflowTriggerApi* | [**trigger_workflow**](docs/WorkflowTriggerApi.md#trigger_workflow) | **POST** aow-auth/v1.0/accounts/{accountId}/workflows/trigger | Creates a new workflow instance after authenticating with DS Account Server
|
99
|
+
|
100
|
+
|
101
|
+
## Documentation for Models
|
102
|
+
|
103
|
+
- [DocuSign_Maestro::AccessTokenResponse](docs/AccessTokenResponse.md)
|
104
|
+
- [DocuSign_Maestro::AccessTokenTokenTypes](docs/AccessTokenTokenTypes.md)
|
105
|
+
- [DocuSign_Maestro::CancelResponse](docs/CancelResponse.md)
|
106
|
+
- [DocuSign_Maestro::CreateOrUpdateWorkflowDefinitionRequestBody](docs/CreateOrUpdateWorkflowDefinitionRequestBody.md)
|
107
|
+
- [DocuSign_Maestro::DSDoUntilStep](docs/DSDoUntilStep.md)
|
108
|
+
- [DocuSign_Maestro::DSDocGenStep](docs/DSDocGenStep.md)
|
109
|
+
- [DocuSign_Maestro::DSDocGenStepInput](docs/DSDocGenStepInput.md)
|
110
|
+
- [DocuSign_Maestro::DSIdvStep](docs/DSIdvStep.md)
|
111
|
+
- [DocuSign_Maestro::DSIdvStepInput](docs/DSIdvStepInput.md)
|
112
|
+
- [DocuSign_Maestro::DSIfElseStep](docs/DSIfElseStep.md)
|
113
|
+
- [DocuSign_Maestro::DSLoopStep](docs/DSLoopStep.md)
|
114
|
+
- [DocuSign_Maestro::DSParallelStep](docs/DSParallelStep.md)
|
115
|
+
- [DocuSign_Maestro::DSServiceStep](docs/DSServiceStep.md)
|
116
|
+
- [DocuSign_Maestro::DSSignStep](docs/DSSignStep.md)
|
117
|
+
- [DocuSign_Maestro::DSSignStepInput](docs/DSSignStepInput.md)
|
118
|
+
- [DocuSign_Maestro::DSTransformationStep](docs/DSTransformationStep.md)
|
119
|
+
- [DocuSign_Maestro::DSWebFormsStep](docs/DSWebFormsStep.md)
|
120
|
+
- [DocuSign_Maestro::DSWebFormsStepConfig](docs/DSWebFormsStepConfig.md)
|
121
|
+
- [DocuSign_Maestro::DSWorkflowBooleanExpression](docs/DSWorkflowBooleanExpression.md)
|
122
|
+
- [DocuSign_Maestro::DSWorkflowComparisonExpression](docs/DSWorkflowComparisonExpression.md)
|
123
|
+
- [DocuSign_Maestro::DSWorkflowComparisonOperatorTypes](docs/DSWorkflowComparisonOperatorTypes.md)
|
124
|
+
- [DocuSign_Maestro::DSWorkflowConcatExpression](docs/DSWorkflowConcatExpression.md)
|
125
|
+
- [DocuSign_Maestro::DSWorkflowDocGenDocOutputFormat](docs/DSWorkflowDocGenDocOutputFormat.md)
|
126
|
+
- [DocuSign_Maestro::DSWorkflowExpressionTypesBooleanExpression](docs/DSWorkflowExpressionTypesBooleanExpression.md)
|
127
|
+
- [DocuSign_Maestro::DSWorkflowExpressionTypesComparisonExpression](docs/DSWorkflowExpressionTypesComparisonExpression.md)
|
128
|
+
- [DocuSign_Maestro::DSWorkflowExpressionTypesParallelExpression](docs/DSWorkflowExpressionTypesParallelExpression.md)
|
129
|
+
- [DocuSign_Maestro::DSWorkflowIndexOfExpression](docs/DSWorkflowIndexOfExpression.md)
|
130
|
+
- [DocuSign_Maestro::DSWorkflowLane](docs/DSWorkflowLane.md)
|
131
|
+
- [DocuSign_Maestro::DSWorkflowLanesRecord](docs/DSWorkflowLanesRecord.md)
|
132
|
+
- [DocuSign_Maestro::DSWorkflowLastIndexOfExpression](docs/DSWorkflowLastIndexOfExpression.md)
|
133
|
+
- [DocuSign_Maestro::DSWorkflowLogicalOperatorTypes](docs/DSWorkflowLogicalOperatorTypes.md)
|
134
|
+
- [DocuSign_Maestro::DSWorkflowParallelExpression](docs/DSWorkflowParallelExpression.md)
|
135
|
+
- [DocuSign_Maestro::DSWorkflowParticipantRecord](docs/DSWorkflowParticipantRecord.md)
|
136
|
+
- [DocuSign_Maestro::DSWorkflowReplaceExpression](docs/DSWorkflowReplaceExpression.md)
|
137
|
+
- [DocuSign_Maestro::DSWorkflowStep](docs/DSWorkflowStep.md)
|
138
|
+
- [DocuSign_Maestro::DSWorkflowStepTypesDSDocGen](docs/DSWorkflowStepTypesDSDocGen.md)
|
139
|
+
- [DocuSign_Maestro::DSWorkflowStepTypesDSIdv](docs/DSWorkflowStepTypesDSIdv.md)
|
140
|
+
- [DocuSign_Maestro::DSWorkflowStepTypesDSIfElse](docs/DSWorkflowStepTypesDSIfElse.md)
|
141
|
+
- [DocuSign_Maestro::DSWorkflowStepTypesDSSign](docs/DSWorkflowStepTypesDSSign.md)
|
142
|
+
- [DocuSign_Maestro::DSWorkflowStepTypesDSTransformation](docs/DSWorkflowStepTypesDSTransformation.md)
|
143
|
+
- [DocuSign_Maestro::DSWorkflowStepTypesDSWebForms](docs/DSWorkflowStepTypesDSWebForms.md)
|
144
|
+
- [DocuSign_Maestro::DSWorkflowStepTypesDoUntil](docs/DSWorkflowStepTypesDoUntil.md)
|
145
|
+
- [DocuSign_Maestro::DSWorkflowStepTypesLoop](docs/DSWorkflowStepTypesLoop.md)
|
146
|
+
- [DocuSign_Maestro::DSWorkflowStepTypesParallel](docs/DSWorkflowStepTypesParallel.md)
|
147
|
+
- [DocuSign_Maestro::DSWorkflowSubstringExpression](docs/DSWorkflowSubstringExpression.md)
|
148
|
+
- [DocuSign_Maestro::DSWorkflowToLowerExpression](docs/DSWorkflowToLowerExpression.md)
|
149
|
+
- [DocuSign_Maestro::DSWorkflowToUpperExpression](docs/DSWorkflowToUpperExpression.md)
|
150
|
+
- [DocuSign_Maestro::DSWorkflowTransformationExpression](docs/DSWorkflowTransformationExpression.md)
|
151
|
+
- [DocuSign_Maestro::DSWorkflowTransformationExpressionTypesConcatExpression](docs/DSWorkflowTransformationExpressionTypesConcatExpression.md)
|
152
|
+
- [DocuSign_Maestro::DSWorkflowTransformationExpressionTypesIndexOfExpression](docs/DSWorkflowTransformationExpressionTypesIndexOfExpression.md)
|
153
|
+
- [DocuSign_Maestro::DSWorkflowTransformationExpressionTypesLastIndexOfExpression](docs/DSWorkflowTransformationExpressionTypesLastIndexOfExpression.md)
|
154
|
+
- [DocuSign_Maestro::DSWorkflowTransformationExpressionTypesReplaceExpression](docs/DSWorkflowTransformationExpressionTypesReplaceExpression.md)
|
155
|
+
- [DocuSign_Maestro::DSWorkflowTransformationExpressionTypesSubstringExpression](docs/DSWorkflowTransformationExpressionTypesSubstringExpression.md)
|
156
|
+
- [DocuSign_Maestro::DSWorkflowTransformationExpressionTypesToLowerExpression](docs/DSWorkflowTransformationExpressionTypesToLowerExpression.md)
|
157
|
+
- [DocuSign_Maestro::DSWorkflowTransformationExpressionTypesToUpperExpression](docs/DSWorkflowTransformationExpressionTypesToUpperExpression.md)
|
158
|
+
- [DocuSign_Maestro::DSWorkflowTrigger](docs/DSWorkflowTrigger.md)
|
159
|
+
- [DocuSign_Maestro::DSWorkflowTriggerTypes](docs/DSWorkflowTriggerTypes.md)
|
160
|
+
- [DocuSign_Maestro::DSWorkflowVariable](docs/DSWorkflowVariable.md)
|
161
|
+
- [DocuSign_Maestro::DSWorkflowVariableFromParticipant](docs/DSWorkflowVariableFromParticipant.md)
|
162
|
+
- [DocuSign_Maestro::DSWorkflowVariableFromStep](docs/DSWorkflowVariableFromStep.md)
|
163
|
+
- [DocuSign_Maestro::DSWorkflowVariableFromVariable](docs/DSWorkflowVariableFromVariable.md)
|
164
|
+
- [DocuSign_Maestro::DSWorkflowVariableRecord](docs/DSWorkflowVariableRecord.md)
|
165
|
+
- [DocuSign_Maestro::DSWorkflowVariableSourceTypesParticipant](docs/DSWorkflowVariableSourceTypesParticipant.md)
|
166
|
+
- [DocuSign_Maestro::DSWorkflowVariableSourceTypesStep](docs/DSWorkflowVariableSourceTypesStep.md)
|
167
|
+
- [DocuSign_Maestro::DSWorkflowVariableSourceTypesVariable](docs/DSWorkflowVariableSourceTypesVariable.md)
|
168
|
+
- [DocuSign_Maestro::DeployRequest](docs/DeployRequest.md)
|
169
|
+
- [DocuSign_Maestro::DeployResponse](docs/DeployResponse.md)
|
170
|
+
- [DocuSign_Maestro::DeployStatus](docs/DeployStatus.md)
|
171
|
+
- [DocuSign_Maestro::DeploymentStatus](docs/DeploymentStatus.md)
|
172
|
+
- [DocuSign_Maestro::ESignDocumentFromESignTemplate](docs/ESignDocumentFromESignTemplate.md)
|
173
|
+
- [DocuSign_Maestro::ESignDocumentFromPreviousStep](docs/ESignDocumentFromPreviousStep.md)
|
174
|
+
- [DocuSign_Maestro::ESignDocumentTypesFromDSTemplate](docs/ESignDocumentTypesFromDSTemplate.md)
|
175
|
+
- [DocuSign_Maestro::ESignDocumentTypesFromPreviousStep](docs/ESignDocumentTypesFromPreviousStep.md)
|
176
|
+
- [DocuSign_Maestro::ESignDocuments](docs/ESignDocuments.md)
|
177
|
+
- [DocuSign_Maestro::ESignLocalePolicy](docs/ESignLocalePolicy.md)
|
178
|
+
- [DocuSign_Maestro::ESignSigner](docs/ESignSigner.md)
|
179
|
+
- [DocuSign_Maestro::ESignTabs](docs/ESignTabs.md)
|
180
|
+
- [DocuSign_Maestro::ESignTabsRecord](docs/ESignTabsRecord.md)
|
181
|
+
- [DocuSign_Maestro::ErrorCodes](docs/ErrorCodes.md)
|
182
|
+
- [DocuSign_Maestro::ErrorResponse](docs/ErrorResponse.md)
|
183
|
+
- [DocuSign_Maestro::EventTypes](docs/EventTypes.md)
|
184
|
+
- [DocuSign_Maestro::GetConfigurationInstanceResponse](docs/GetConfigurationInstanceResponse.md)
|
185
|
+
- [DocuSign_Maestro::GetConfigurationInstancesResponse](docs/GetConfigurationInstancesResponse.md)
|
186
|
+
- [DocuSign_Maestro::GetConfigurationInstancesResponseConfigInstances](docs/GetConfigurationInstancesResponseConfigInstances.md)
|
187
|
+
- [DocuSign_Maestro::HttpTypes](docs/HttpTypes.md)
|
188
|
+
- [DocuSign_Maestro::InvalidWorkflowResponse](docs/InvalidWorkflowResponse.md)
|
189
|
+
- [DocuSign_Maestro::NewOrUpdatedWorkflowDefinitionResponse](docs/NewOrUpdatedWorkflowDefinitionResponse.md)
|
190
|
+
- [DocuSign_Maestro::NumberOrVariable](docs/NumberOrVariable.md)
|
191
|
+
- [DocuSign_Maestro::Participant](docs/Participant.md)
|
192
|
+
- [DocuSign_Maestro::ParticipantKeys](docs/ParticipantKeys.md)
|
193
|
+
- [DocuSign_Maestro::ProgressInstance](docs/ProgressInstance.md)
|
194
|
+
- [DocuSign_Maestro::RecordStringBoolean](docs/RecordStringBoolean.md)
|
195
|
+
- [DocuSign_Maestro::RecordStringOrVariableOrTransformation](docs/RecordStringOrVariableOrTransformation.md)
|
196
|
+
- [DocuSign_Maestro::RecordToNever](docs/RecordToNever.md)
|
197
|
+
- [DocuSign_Maestro::ReplicationStatus](docs/ReplicationStatus.md)
|
198
|
+
- [DocuSign_Maestro::StartedByInstance](docs/StartedByInstance.md)
|
199
|
+
- [DocuSign_Maestro::StringOrVariableOrTransformation](docs/StringOrVariableOrTransformation.md)
|
200
|
+
- [DocuSign_Maestro::SuccessMessageResponse](docs/SuccessMessageResponse.md)
|
201
|
+
- [DocuSign_Maestro::TriggerPayload](docs/TriggerPayload.md)
|
202
|
+
- [DocuSign_Maestro::TriggerWorkflowViaPostResponse](docs/TriggerWorkflowViaPostResponse.md)
|
203
|
+
- [DocuSign_Maestro::ValidationErrors](docs/ValidationErrors.md)
|
204
|
+
- [DocuSign_Maestro::WorkflowDefinition](docs/WorkflowDefinition.md)
|
205
|
+
- [DocuSign_Maestro::WorkflowDefinitionList](docs/WorkflowDefinitionList.md)
|
206
|
+
- [DocuSign_Maestro::WorkflowDefinitionMetadata](docs/WorkflowDefinitionMetadata.md)
|
207
|
+
- [DocuSign_Maestro::WorkflowDefinitionWithId](docs/WorkflowDefinitionWithId.md)
|
208
|
+
- [DocuSign_Maestro::WorkflowDeleteResponse](docs/WorkflowDeleteResponse.md)
|
209
|
+
- [DocuSign_Maestro::WorkflowInstance](docs/WorkflowInstance.md)
|
210
|
+
- [DocuSign_Maestro::WorkflowInstanceMap](docs/WorkflowInstanceMap.md)
|
211
|
+
- [DocuSign_Maestro::WorkflowInstanceState](docs/WorkflowInstanceState.md)
|
212
|
+
- [DocuSign_Maestro::WorkflowInstancesList](docs/WorkflowInstancesList.md)
|
213
|
+
- [DocuSign_Maestro::WorkflowMetadataStatus](docs/WorkflowMetadataStatus.md)
|
214
|
+
- [DocuSign_Maestro::WorkflowStepError](docs/WorkflowStepError.md)
|
215
|
+
- [DocuSign_Maestro::WorkflowStepErrorError](docs/WorkflowStepErrorError.md)
|
216
|
+
- [DocuSign_Maestro::WorkflowStepHistory](docs/WorkflowStepHistory.md)
|
217
|
+
- [DocuSign_Maestro::WorkflowStepHistoryList](docs/WorkflowStepHistoryList.md)
|
218
|
+
- [DocuSign_Maestro::WorkflowStepHistoryState](docs/WorkflowStepHistoryState.md)
|
219
|
+
|
220
|
+
|
221
|
+
## Documentation for Authorization
|
222
|
+
|
223
|
+
|
224
|
+
### docusignAccessCode
|
225
|
+
|
226
|
+
- **Type**: OAuth
|
227
|
+
- **Flow**: accessCode
|
228
|
+
- **Authorization URL**: https://account.docusign.com/oauth/auth
|
229
|
+
- **Scopes**: N/A
|
230
|
+
|
@@ -0,0 +1,48 @@
|
|
1
|
+
# -*- encoding: utf-8 -*-
|
2
|
+
|
3
|
+
=begin
|
4
|
+
#Maestro API
|
5
|
+
|
6
|
+
#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
|
7
|
+
|
8
|
+
OpenAPI spec version: 1.0.0
|
9
|
+
Contact: devcenter@docusign.com
|
10
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
11
|
+
|
12
|
+
=end
|
13
|
+
|
14
|
+
$:.push File.expand_path("../lib", __FILE__)
|
15
|
+
require "docusign_maestro/version"
|
16
|
+
|
17
|
+
Gem::Specification.new do |s|
|
18
|
+
s.name = "docusign_maestro"
|
19
|
+
s.version = DocuSign_Maestro::VERSION
|
20
|
+
s.platform = Gem::Platform::RUBY
|
21
|
+
s.authors = ["DocuSign"]
|
22
|
+
s.email = ["devcenter@docusign.com"]
|
23
|
+
s.homepage = "https://github.com/docusign/docusign-maestro-ruby-client"
|
24
|
+
s.summary = "Maestro API Ruby Gem"
|
25
|
+
s.description = "The DocuSign package makes integrating DocuSign into your apps and websites a super fast and painless process. The library is open sourced on GitHub, look for the docusign-maestro-ruby-client repository."
|
26
|
+
s.license = "MIT"
|
27
|
+
s.required_ruby_version = ">= 1.9"
|
28
|
+
|
29
|
+
s.add_runtime_dependency 'jwt', '~> 2.2', '>= 2.2.1'
|
30
|
+
s.add_runtime_dependency 'addressable', '~> 2.7', '>= 2.7.0'
|
31
|
+
s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
|
32
|
+
s.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.0'
|
33
|
+
|
34
|
+
s.add_development_dependency 'rspec-mocks', '~> 3.8', '>= 3.8.0'
|
35
|
+
s.add_development_dependency 'rspec-expectations', '~> 3.8', '>= 3.8.0'
|
36
|
+
s.add_development_dependency 'rspec', '~> 3.4', '>= 3.4.0'
|
37
|
+
s.add_development_dependency 'vcr', '~> 3.0', '>= 3.0.1'
|
38
|
+
s.add_development_dependency 'webmock', '~> 1.24', '>= 1.24.3'
|
39
|
+
s.add_development_dependency 'autotest', '~> 4.4', '>= 4.4.6'
|
40
|
+
s.add_development_dependency 'autotest-rails-pure', '~> 4.1', '>= 4.1.2'
|
41
|
+
s.add_development_dependency 'autotest-growl', '~> 0.2', '>= 0.2.16'
|
42
|
+
s.add_development_dependency 'autotest-fsevent', '~> 0.2', '>= 0.2.11'
|
43
|
+
|
44
|
+
s.files = `find *`.split("\n").uniq.sort.select{|f| !f.empty? }
|
45
|
+
s.test_files = `find spec/*`.split("\n")
|
46
|
+
s.executables = []
|
47
|
+
s.require_paths = ["lib"]
|
48
|
+
end
|
@@ -0,0 +1,248 @@
|
|
1
|
+
=begin
|
2
|
+
#Maestro API
|
3
|
+
|
4
|
+
#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
|
5
|
+
|
6
|
+
OpenAPI spec version: 1.0.0
|
7
|
+
Contact: devcenter@docusign.com
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
+
|
10
|
+
=end
|
11
|
+
|
12
|
+
require "uri"
|
13
|
+
|
14
|
+
module DocuSign_Maestro
|
15
|
+
|
16
|
+
|
17
|
+
class WorkflowInstanceManagementApi
|
18
|
+
attr_accessor :api_client
|
19
|
+
|
20
|
+
def initialize(api_client = WorkflowInstanceManagementApi.default)
|
21
|
+
@api_client = api_client
|
22
|
+
end
|
23
|
+
|
24
|
+
# Cancels a running workflow instance.
|
25
|
+
# Cancels a running workflow instance.
|
26
|
+
# @param account_id Account ID
|
27
|
+
# @param instance_id DS Workflow Instance Id (dacId)
|
28
|
+
# @return [CancelResponse]
|
29
|
+
def cancel_workflow_instance(account_id, instance_id)
|
30
|
+
data, _status_code, _headers = cancel_workflow_instance_with_http_info(account_id, instance_id)
|
31
|
+
return data
|
32
|
+
end
|
33
|
+
|
34
|
+
# Cancels a running workflow instance.
|
35
|
+
# Cancels a running workflow instance.
|
36
|
+
# @param account_id Account ID
|
37
|
+
# @param instance_id DS Workflow Instance Id (dacId)
|
38
|
+
# @return [Array<(CancelResponse, Fixnum, Hash)>] CancelResponse data, response status code and response headers
|
39
|
+
def cancel_workflow_instance_with_http_info(account_id, instance_id)
|
40
|
+
if @api_client.config.debugging
|
41
|
+
@api_client.config.logger.debug "Calling API: WorkflowInstanceManagementApi.cancel_workflow_instance ..."
|
42
|
+
end
|
43
|
+
# verify the required parameter 'account_id' is set
|
44
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling WorkflowInstanceManagementApi.cancel_workflow_instance" if account_id.nil?
|
45
|
+
# verify the required parameter 'instance_id' is set
|
46
|
+
fail ArgumentError, "Missing the required parameter 'instance_id' when calling WorkflowInstanceManagementApi.cancel_workflow_instance" if instance_id.nil?
|
47
|
+
# resource path
|
48
|
+
local_var_path = "aow-manage/v1.0/management/accounts/{accountId}/instances/{instanceId}/cancel".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'instanceId' + '}', instance_id.to_s)
|
49
|
+
|
50
|
+
# query parameters
|
51
|
+
query_params = {}
|
52
|
+
|
53
|
+
# header parameters
|
54
|
+
header_params = {}
|
55
|
+
# HTTP header 'Accept' (if needed)
|
56
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
57
|
+
# HTTP header 'Content-Type'
|
58
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
59
|
+
|
60
|
+
# form parameters
|
61
|
+
form_params = {}
|
62
|
+
|
63
|
+
# http body (model)
|
64
|
+
post_body = nil
|
65
|
+
auth_names = []
|
66
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
67
|
+
:header_params => header_params,
|
68
|
+
:query_params => query_params,
|
69
|
+
:form_params => form_params,
|
70
|
+
:body => post_body,
|
71
|
+
:auth_names => auth_names,
|
72
|
+
:return_type => 'CancelResponse')
|
73
|
+
if @api_client.config.debugging
|
74
|
+
@api_client.config.logger.debug "API called: WorkflowInstanceManagementApi#cancel_workflow_instance\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
75
|
+
end
|
76
|
+
return data, status_code, headers
|
77
|
+
end
|
78
|
+
|
79
|
+
# Get List of Step Histories
|
80
|
+
# Returns a list of step history for a workflow instance
|
81
|
+
# @param account_id Account ID
|
82
|
+
# @param instance_id DS Workflow Instance Id (dacId)
|
83
|
+
# @return [Array<WorkflowStepHistory>]
|
84
|
+
def get_workflow_history(account_id, instance_id)
|
85
|
+
data, _status_code, _headers = get_workflow_history_with_http_info(account_id, instance_id)
|
86
|
+
return data
|
87
|
+
end
|
88
|
+
|
89
|
+
# Get List of Step Histories
|
90
|
+
# Returns a list of step history for a workflow instance
|
91
|
+
# @param account_id Account ID
|
92
|
+
# @param instance_id DS Workflow Instance Id (dacId)
|
93
|
+
# @return [Array<(Array<WorkflowStepHistory>, Fixnum, Hash)>] Array<WorkflowStepHistory> data, response status code and response headers
|
94
|
+
def get_workflow_history_with_http_info(account_id, instance_id)
|
95
|
+
if @api_client.config.debugging
|
96
|
+
@api_client.config.logger.debug "Calling API: WorkflowInstanceManagementApi.get_workflow_history ..."
|
97
|
+
end
|
98
|
+
# verify the required parameter 'account_id' is set
|
99
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling WorkflowInstanceManagementApi.get_workflow_history" if account_id.nil?
|
100
|
+
# verify the required parameter 'instance_id' is set
|
101
|
+
fail ArgumentError, "Missing the required parameter 'instance_id' when calling WorkflowInstanceManagementApi.get_workflow_history" if instance_id.nil?
|
102
|
+
# resource path
|
103
|
+
local_var_path = "aow-manage/v1.0/management/accounts/{accountId}/instances/{instanceId}/history".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'instanceId' + '}', instance_id.to_s)
|
104
|
+
|
105
|
+
# query parameters
|
106
|
+
query_params = {}
|
107
|
+
|
108
|
+
# header parameters
|
109
|
+
header_params = {}
|
110
|
+
# HTTP header 'Accept' (if needed)
|
111
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
112
|
+
# HTTP header 'Content-Type'
|
113
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
114
|
+
|
115
|
+
# form parameters
|
116
|
+
form_params = {}
|
117
|
+
|
118
|
+
# http body (model)
|
119
|
+
post_body = nil
|
120
|
+
auth_names = []
|
121
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
122
|
+
:header_params => header_params,
|
123
|
+
:query_params => query_params,
|
124
|
+
:form_params => form_params,
|
125
|
+
:body => post_body,
|
126
|
+
:auth_names => auth_names,
|
127
|
+
:return_type => 'Array<WorkflowStepHistory>')
|
128
|
+
if @api_client.config.debugging
|
129
|
+
@api_client.config.logger.debug "API called: WorkflowInstanceManagementApi#get_workflow_history\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
130
|
+
end
|
131
|
+
return data, status_code, headers
|
132
|
+
end
|
133
|
+
|
134
|
+
# Get Workflow Instance Details
|
135
|
+
# Returns the details for a specific instance for a deployed workflow definition.
|
136
|
+
# @param account_id Account ID
|
137
|
+
# @param workflow_definition_id Workflow Definition ID
|
138
|
+
# @param instance_id DS Workflow Instance Id (dacId)
|
139
|
+
# @return [WorkflowInstance]
|
140
|
+
def get_workflow_instance(account_id, workflow_definition_id, instance_id)
|
141
|
+
data, _status_code, _headers = get_workflow_instance_with_http_info(account_id, workflow_definition_id, instance_id)
|
142
|
+
return data
|
143
|
+
end
|
144
|
+
|
145
|
+
# Get Workflow Instance Details
|
146
|
+
# Returns the details for a specific instance for a deployed workflow definition.
|
147
|
+
# @param account_id Account ID
|
148
|
+
# @param workflow_definition_id Workflow Definition ID
|
149
|
+
# @param instance_id DS Workflow Instance Id (dacId)
|
150
|
+
# @return [Array<(WorkflowInstance, Fixnum, Hash)>] WorkflowInstance data, response status code and response headers
|
151
|
+
def get_workflow_instance_with_http_info(account_id, workflow_definition_id, instance_id)
|
152
|
+
if @api_client.config.debugging
|
153
|
+
@api_client.config.logger.debug "Calling API: WorkflowInstanceManagementApi.get_workflow_instance ..."
|
154
|
+
end
|
155
|
+
# verify the required parameter 'account_id' is set
|
156
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling WorkflowInstanceManagementApi.get_workflow_instance" if account_id.nil?
|
157
|
+
# verify the required parameter 'workflow_definition_id' is set
|
158
|
+
fail ArgumentError, "Missing the required parameter 'workflow_definition_id' when calling WorkflowInstanceManagementApi.get_workflow_instance" if workflow_definition_id.nil?
|
159
|
+
# verify the required parameter 'instance_id' is set
|
160
|
+
fail ArgumentError, "Missing the required parameter 'instance_id' when calling WorkflowInstanceManagementApi.get_workflow_instance" if instance_id.nil?
|
161
|
+
# resource path
|
162
|
+
local_var_path = "aow-manage/v1.0/management/accounts/{accountId}/workflowDefinitions/{workflowDefinitionId}/instances/{instanceId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'workflowDefinitionId' + '}', workflow_definition_id.to_s).sub('{' + 'instanceId' + '}', instance_id.to_s)
|
163
|
+
|
164
|
+
# query parameters
|
165
|
+
query_params = {}
|
166
|
+
|
167
|
+
# header parameters
|
168
|
+
header_params = {}
|
169
|
+
# HTTP header 'Accept' (if needed)
|
170
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
171
|
+
# HTTP header 'Content-Type'
|
172
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
173
|
+
|
174
|
+
# form parameters
|
175
|
+
form_params = {}
|
176
|
+
|
177
|
+
# http body (model)
|
178
|
+
post_body = nil
|
179
|
+
auth_names = []
|
180
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
181
|
+
:header_params => header_params,
|
182
|
+
:query_params => query_params,
|
183
|
+
:form_params => form_params,
|
184
|
+
:body => post_body,
|
185
|
+
:auth_names => auth_names,
|
186
|
+
:return_type => 'WorkflowInstance')
|
187
|
+
if @api_client.config.debugging
|
188
|
+
@api_client.config.logger.debug "API called: WorkflowInstanceManagementApi#get_workflow_instance\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
189
|
+
end
|
190
|
+
return data, status_code, headers
|
191
|
+
end
|
192
|
+
|
193
|
+
# Get List of Workflow Instances
|
194
|
+
# Returns the list of instances for a deployed workflow definition.
|
195
|
+
# @param account_id Account ID
|
196
|
+
# @param workflow_definition_id Workflow Definition ID
|
197
|
+
# @return [Array<WorkflowInstance>]
|
198
|
+
def get_workflow_instances(account_id, workflow_definition_id)
|
199
|
+
data, _status_code, _headers = get_workflow_instances_with_http_info(account_id, workflow_definition_id)
|
200
|
+
return data
|
201
|
+
end
|
202
|
+
|
203
|
+
# Get List of Workflow Instances
|
204
|
+
# Returns the list of instances for a deployed workflow definition.
|
205
|
+
# @param account_id Account ID
|
206
|
+
# @param workflow_definition_id Workflow Definition ID
|
207
|
+
# @return [Array<(Array<WorkflowInstance>, Fixnum, Hash)>] Array<WorkflowInstance> data, response status code and response headers
|
208
|
+
def get_workflow_instances_with_http_info(account_id, workflow_definition_id)
|
209
|
+
if @api_client.config.debugging
|
210
|
+
@api_client.config.logger.debug "Calling API: WorkflowInstanceManagementApi.get_workflow_instances ..."
|
211
|
+
end
|
212
|
+
# verify the required parameter 'account_id' is set
|
213
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling WorkflowInstanceManagementApi.get_workflow_instances" if account_id.nil?
|
214
|
+
# verify the required parameter 'workflow_definition_id' is set
|
215
|
+
fail ArgumentError, "Missing the required parameter 'workflow_definition_id' when calling WorkflowInstanceManagementApi.get_workflow_instances" if workflow_definition_id.nil?
|
216
|
+
# resource path
|
217
|
+
local_var_path = "aow-manage/v1.0/management/accounts/{accountId}/workflowDefinitions/{workflowDefinitionId}/instances".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'workflowDefinitionId' + '}', workflow_definition_id.to_s)
|
218
|
+
|
219
|
+
# query parameters
|
220
|
+
query_params = {}
|
221
|
+
|
222
|
+
# header parameters
|
223
|
+
header_params = {}
|
224
|
+
# HTTP header 'Accept' (if needed)
|
225
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
226
|
+
# HTTP header 'Content-Type'
|
227
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
228
|
+
|
229
|
+
# form parameters
|
230
|
+
form_params = {}
|
231
|
+
|
232
|
+
# http body (model)
|
233
|
+
post_body = nil
|
234
|
+
auth_names = []
|
235
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
236
|
+
:header_params => header_params,
|
237
|
+
:query_params => query_params,
|
238
|
+
:form_params => form_params,
|
239
|
+
:body => post_body,
|
240
|
+
:auth_names => auth_names,
|
241
|
+
:return_type => 'Array<WorkflowInstance>')
|
242
|
+
if @api_client.config.debugging
|
243
|
+
@api_client.config.logger.debug "API called: WorkflowInstanceManagementApi#get_workflow_instances\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
244
|
+
end
|
245
|
+
return data, status_code, headers
|
246
|
+
end
|
247
|
+
end
|
248
|
+
end
|