docusign_maestro 1.0.0.rc1 → 2.0.0.rc1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (19) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +8 -31
  3. data/README.md +94 -229
  4. data/lib/docusign_maestro/api/workflow_instance_management_api.rb +4 -4
  5. data/lib/docusign_maestro/api/workflow_management_api.rb +7 -7
  6. data/lib/docusign_maestro/api/workflow_trigger_api.rb +8 -4
  7. data/lib/docusign_maestro/client/api_client.rb +1 -1
  8. data/lib/docusign_maestro/configuration.rb +2 -2
  9. data/lib/docusign_maestro/models/deployment_status.rb +2 -0
  10. data/lib/docusign_maestro/models/ds_workflow_variable_from_participant.rb +3 -45
  11. data/lib/docusign_maestro/models/error_codes.rb +1 -0
  12. data/lib/docusign_maestro/models/event_types.rb +13 -0
  13. data/lib/docusign_maestro/models/started_by_instance.rb +2 -2
  14. data/lib/docusign_maestro/models/workflow_instance.rb +1 -0
  15. data/lib/docusign_maestro/models/workflow_instance_state.rb +2 -0
  16. data/lib/docusign_maestro/models/workflow_step_history_state.rb +1 -0
  17. data/lib/docusign_maestro/version.rb +1 -1
  18. data/lib/docusign_maestro.rb +0 -2
  19. metadata +2 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: d9035d9f146882286b74ed5992b864d94ed78b3b5dcad1b18a9b4ea22a8f0da9
4
- data.tar.gz: 5e57a66947767308631d332625b564b2f91a710a7a12543a33acc7a95ad53c0c
3
+ metadata.gz: 1fdb07237d5d6e88f046c08c1accfde3db25f5de9a554efbddf8d4d098d44d06
4
+ data.tar.gz: a1b7358a61ec68c715fcf0115729f42875848a2df14a5de7d9abfcb4df265aa5
5
5
  SHA512:
6
- metadata.gz: 9fb9036d4c322cfb76a3da0a16db6ab7a1a062ba31561074661cc738babdc9a9183b22326a99cbd7bc51c8ecdda247e3c866012b6188b59ae62e94bcece03885
7
- data.tar.gz: feec8ac16f8e8deafd7f100542a6c0db6f1d70358f2a6a8aa71f15e4a90184e6eb95de5f717d9e128d4a272a249db24f5095614cc72b991346e0894ddb8f6697
6
+ metadata.gz: e27300b7c24e902a1c61af64a9120a63c353975685f03d930c6e303db1a504502641c677567c848a31e125b408a854f3d6bd0ec2b8eb79381a541b2bd4c8d35e
7
+ data.tar.gz: 37457cf32a0b173b0a59044411eb30f3a45b5e9dfb2b7a060abd8b8aae13378f17a5198f45809c973321102eb1c5b8901de75c2aeca6772a6521bcb7f3202492
data/CHANGELOG.md CHANGED
@@ -1,35 +1,12 @@
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
1
+ ## [v2.0.0.rc1] - Maestro API v1.0.0-1.0.5 - 2024-06-07
12
2
  ### Changed
13
- - Added support for version v1.0.0-1.0.0 of the DocuSign Maestro API.
3
+ - Added support for version v1.0.0-1.0.5 of the DocuSign Maestro API.
14
4
  - Updated the SDK release version.
15
5
 
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.
6
+ ## [v1.0.0] - Maestro API v1.0.0-1.0.4 - 2024-04-22
7
+ ## Version 1.0.0 (Initial Release)
8
+ - Announcing the SDK built on the OpenAPI specification for DocuSign Maestro APIs.
9
+ - This release signifies the initial launch of the SDK, offering developers the essential tools for seamless interaction with DocuSign Maestro APIs.
35
10
 
11
+ ## [v1.0.0.rc1] - Maestro API v1.0.0-1.0.3 - 2024-04-03
12
+ - Announcing the Release Candidate SDK built on the OpenAPI specification for DocuSign Maestro APIs.
data/README.md CHANGED
@@ -1,230 +1,95 @@
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
-
1
+ # The Official Docusign Maestro Ruby Client SDK
2
+
3
+ The Docusign SDK makes integrating Docusign into your apps and websites a seamless experience.
4
+
5
+ ## Table of Contents
6
+ - [Introduction](#introduction)
7
+ - [Installation](#installation)
8
+ * [Version Information](#versionInformation)
9
+ * [Requirements](#requirements)
10
+ * [Compatibility](#compatibility)
11
+ * [Installation via your application's Gemfile](#installationViaGem)
12
+ * [Manual Installation](#manualInstallation)
13
+ - [Dependencies](#dependencies)
14
+ - [API Reference](#apiReference)
15
+ - [Code Examples](#codeExamples)
16
+ - [OAuth Implementations](#oauthImplementations)
17
+ - [Changelog](#changeLog)
18
+ - [Support](#support)
19
+ - [License](#license)
20
+ - [Additional Resources](#additionalResources)
21
+
22
+ <a id="introduction"></a>
23
+ ## Introduction
24
+ Leverage the power of Docusign workflows. Enjoy greater flexibility to manage your agreements using your own code in concert with the Maestro Workflow Designer.
25
+
26
+ <a id="installation"></a>
14
27
  ## 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
-
28
+ This client SDK is provided as open source, which enables you to customize its functionality to suit your particular use case. To do so, download or clone the repository. If the SDK’s given functionality meets your integration needs, or if you’re working through our [code examples](https://developers.docusign.com/docs/maestro-api/how-to/) from the [Docusign Developer Center](https://developers.docusign.com/), you merely need to install it by following the instructions below.
29
+
30
+ <a id="versionInformation"></a>
31
+ ### Version Information
32
+ - **API version**: 1.0.0
33
+ - **Latest SDK version**: 2.0.0.rc1
34
+
35
+ <a id="requirements"></a>
36
+ ## Requirements
37
+ * Ruby 1.9+
38
+ * Free [developer account](https://go.docusign.com/o/sandbox/?postActivateUrl=https://developers.docusign.com/)
39
+
40
+ <a id="compatibility"></a>
41
+ ## Compatibility
42
+ * Ruby 1.9+
43
+
44
+ <a id="installationViaGem"></a>
45
+ ### Installation via your application's Gemfile:
46
+ 1. In your application's Gemfile, add:
47
+ `gem 'docusign_maestro'`
48
+ 2. Open your preferred console.
49
+ 3. In your project directory, execute the installer by typing: **bundle install**
50
+
51
+ <a id="manualInstallation"></a>
52
+ ### Manual Installation:
53
+ 1. Open your preferred console.
54
+ 2. In the console, type: **gem install docusign_maestro**
55
+
56
+ <a id="dependencies"></a>
57
+ ### SDK Dependencies
58
+ This client has the following external dependencies:
59
+ * Jwt v2.2.1
60
+ * Json v2.1.0
61
+ * addressable v2.7.0
62
+ * Typhoeus v1.0.1
63
+
64
+ <a id="apiReference"></a>
65
+ ## API Reference
66
+ You can refer to the API reference [here](https://developers.docusign.com/docs/maestro-api/reference/).
67
+
68
+ <a id="codeExamples"></a>
69
+ ## Code examples
70
+ Explore our GitHub repository for the [Launcher](https://github.com/docusign/code-examples-ruby/), a self-executing package housing code examples for the Maestro Ruby SDK. This package showcases several common use cases and their respective source files. Additionally, you can download a version preconfigured for your Docusign developer account from [Quickstart](https://developers.docusign.com/docs/esign-rest-api/quickstart/). These examples support both the [Authorization Code Grant](https://developers.docusign.com/platform/auth/authcode/) and [JSON Web Token (JWT)](https://developers.docusign.com/platform/auth/jwt/) authentication workflows.
71
+
72
+ <a id="oauthImplementations"></a>
73
+ ## OAuth implementations
74
+ For details regarding which type of OAuth grant will work best for your Docusign integration, see [Choose OAuth Type](https://developers.docusign.com/platform/auth/choose/) in the [Docusign Developer Center](https://developers.docusign.com/).
75
+
76
+ For security purposes, Docusign recommends using the [Authorization Code Grant](https://developers.docusign.com/platform/auth/authcode/) flow.
77
+
78
+ <a id="changeLog"></a>
79
+ ## Changelog
80
+ You can refer to the complete changelog [here](https://github.com/docusign/docusign-maestro-ruby-client/blob/master/CHANGELOG.md).
81
+
82
+ <a id="support"></a>
83
+ ## Support
84
+ Log issues against this client SDK through GitHub. You can also reach out to us through [Docusign Community](https://community.docusign.com/developer-59) and [Stack Overflow](https://stackoverflow.com/questions/tagged/docusignapi).
85
+
86
+ <a id="license"></a>
87
+ ## License
88
+ The Docusign Maestro Ruby Client SDK is licensed under the [MIT License](https://github.com/docusign/docusign-maestro-ruby-client/blob/master/LICENSE).
89
+
90
+ <a id="additionalResources"></a>
91
+ ### Additional resources
92
+ * [Docusign Developer Center](https://developers.docusign.com/)
93
+ * [Docusign API on Twitter](https://twitter.com/docusignapi)
94
+ * [Docusign For Developers on LinkedIn](https://www.linkedin.com/showcase/docusign-for-developers/)
95
+ * [Docusign For Developers on YouTube](https://www.youtube.com/channel/UCJSJ2kMs_qeQotmw4-lX2NQ)
data/lib/docusign_maestro/api/workflow_instance_management_api.rb CHANGED
@@ -45,7 +45,7 @@ module DocuSign_Maestro
45
45
  # verify the required parameter 'instance_id' is set
46
46
  fail ArgumentError, "Missing the required parameter 'instance_id' when calling WorkflowInstanceManagementApi.cancel_workflow_instance" if instance_id.nil?
47
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)
48
+ local_var_path = "/v1/accounts/{accountId}/management/instances/{instanceId}/cancel".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'instanceId' + '}', instance_id.to_s)
49
49
 
50
50
  # query parameters
51
51
  query_params = {}
@@ -100,7 +100,7 @@ module DocuSign_Maestro
100
100
  # verify the required parameter 'instance_id' is set
101
101
  fail ArgumentError, "Missing the required parameter 'instance_id' when calling WorkflowInstanceManagementApi.get_workflow_history" if instance_id.nil?
102
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)
103
+ local_var_path = "/v1/accounts/{accountId}/management/instances/{instanceId}/history".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'instanceId' + '}', instance_id.to_s)
104
104
 
105
105
  # query parameters
106
106
  query_params = {}
@@ -159,7 +159,7 @@ module DocuSign_Maestro
159
159
  # verify the required parameter 'instance_id' is set
160
160
  fail ArgumentError, "Missing the required parameter 'instance_id' when calling WorkflowInstanceManagementApi.get_workflow_instance" if instance_id.nil?
161
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)
162
+ local_var_path = "/v1/accounts/{accountId}/management/workflow_definitions/{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
163
 
164
164
  # query parameters
165
165
  query_params = {}
@@ -214,7 +214,7 @@ module DocuSign_Maestro
214
214
  # verify the required parameter 'workflow_definition_id' is set
215
215
  fail ArgumentError, "Missing the required parameter 'workflow_definition_id' when calling WorkflowInstanceManagementApi.get_workflow_instances" if workflow_definition_id.nil?
216
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)
217
+ local_var_path = "/v1/accounts/{accountId}/management/workflow_definitions/{workflowDefinitionId}/instances".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'workflowDefinitionId' + '}', workflow_definition_id.to_s)
218
218
 
219
219
  # query parameters
220
220
  query_params = {}
data/lib/docusign_maestro/api/workflow_management_api.rb CHANGED
@@ -63,7 +63,7 @@ module DocuSign_Maestro
63
63
  # verify the required parameter 'body' is set
64
64
  fail ArgumentError, "Missing the required parameter 'body' when calling WorkflowManagementApi.create_workflow_definition" if body.nil?
65
65
  # resource path
66
- local_var_path = "aow-manage/v1.0/management/accounts/{accountId}/workflowDefinitions".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
66
+ local_var_path = "/v1/accounts/{accountId}/management/workflow_definitions".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
67
67
 
68
68
  # query parameters
69
69
  query_params = {}
@@ -118,7 +118,7 @@ module DocuSign_Maestro
118
118
  # verify the required parameter 'workflow_definition_id' is set
119
119
  fail ArgumentError, "Missing the required parameter 'workflow_definition_id' when calling WorkflowManagementApi.delete_workflow_definition" if workflow_definition_id.nil?
120
120
  # resource path
121
- local_var_path = "aow-manage/v1.0/management/accounts/{accountId}/workflowDefinitions/{workflowDefinitionId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'workflowDefinitionId' + '}', workflow_definition_id.to_s)
121
+ local_var_path = "/v1/accounts/{accountId}/management/workflow_definitions/{workflowDefinitionId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'workflowDefinitionId' + '}', workflow_definition_id.to_s)
122
122
 
123
123
  # query parameters
124
124
  query_params = {}
@@ -175,7 +175,7 @@ module DocuSign_Maestro
175
175
  # verify the required parameter 'workflow_definition_id' is set
176
176
  fail ArgumentError, "Missing the required parameter 'workflow_definition_id' when calling WorkflowManagementApi.get_workflow_definition" if workflow_definition_id.nil?
177
177
  # resource path
178
- local_var_path = "aow-manage/v1.0/management/accounts/{accountId}/workflowDefinitions/{workflowDefinitionId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'workflowDefinitionId' + '}', workflow_definition_id.to_s)
178
+ local_var_path = "/v1/accounts/{accountId}/management/workflow_definitions/{workflowDefinitionId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'workflowDefinitionId' + '}', workflow_definition_id.to_s)
179
179
 
180
180
  # query parameters
181
181
  query_params = {}
@@ -231,7 +231,7 @@ module DocuSign_Maestro
231
231
  # verify the required parameter 'workflow_definition_id' is set
232
232
  fail ArgumentError, "Missing the required parameter 'workflow_definition_id' when calling WorkflowManagementApi.get_workflow_definition_config_instances" if workflow_definition_id.nil?
233
233
  # resource path
234
- local_var_path = "aow-manage/v1.0/management/accounts/{accountId}/workflowDefinitions/{workflowDefinitionId}/configInstances".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'workflowDefinitionId' + '}', workflow_definition_id.to_s)
234
+ local_var_path = "/v1/accounts/{accountId}/management/workflow_definitions/{workflowDefinitionId}/config_instances".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'workflowDefinitionId' + '}', workflow_definition_id.to_s)
235
235
 
236
236
  # query parameters
237
237
  query_params = {}
@@ -287,7 +287,7 @@ module DocuSign_Maestro
287
287
  fail ArgumentError, 'invalid value for "status", must be one of active, inactive, publishing, unpublishing, archived, archiving'
288
288
  end
289
289
  # resource path
290
- local_var_path = "aow-manage/v1.0/management/accounts/{accountId}/workflowDefinitions".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
290
+ local_var_path = "/v1/accounts/{accountId}/management/workflow_definitions".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
291
291
 
292
292
  # query parameters
293
293
  query_params = {}
@@ -347,7 +347,7 @@ module DocuSign_Maestro
347
347
  # verify the required parameter 'body' is set
348
348
  fail ArgumentError, "Missing the required parameter 'body' when calling WorkflowManagementApi.publish_or_un_publish_workflow_definition" if body.nil?
349
349
  # resource path
350
- local_var_path = "aow-manage/v1.0/management/accounts/{accountId}/workflowDefinitions/{workflowDefinitionId}/publish".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'workflowDefinitionId' + '}', workflow_definition_id.to_s)
350
+ local_var_path = "/v1/accounts/{accountId}/management/workflow_definitions/{workflowDefinitionId}/publish".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'workflowDefinitionId' + '}', workflow_definition_id.to_s)
351
351
 
352
352
  # query parameters
353
353
  query_params = {}
@@ -406,7 +406,7 @@ module DocuSign_Maestro
406
406
  # verify the required parameter 'body' is set
407
407
  fail ArgumentError, "Missing the required parameter 'body' when calling WorkflowManagementApi.update_workflow_definition" if body.nil?
408
408
  # resource path
409
- local_var_path = "aow-manage/v1.0/management/accounts/{accountId}/workflowDefinitions/{workflowDefinitionId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'workflowDefinitionId' + '}', workflow_definition_id.to_s)
409
+ local_var_path = "/v1/accounts/{accountId}/management/workflow_definitions/{workflowDefinitionId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'workflowDefinitionId' + '}', workflow_definition_id.to_s)
410
410
 
411
411
  # query parameters
412
412
  query_params = {}
data/lib/docusign_maestro/api/workflow_trigger_api.rb CHANGED
@@ -36,30 +36,34 @@ module DocuSign_Maestro
36
36
  # Creates a new workflow instance after authenticating with DS Account Server
37
37
  # Creates a new workflow instance after authenticating with DS Account Server
38
38
  # @param account_id Account ID
39
+ # @param workflow_definition_id Workflow Definition ID
39
40
  # @param body JSON payload that will be passed to the triggered workflow
40
41
  # @param DocuSign_Maestro::TriggerWorkflowOptions Options for modifying the behavior of the function.
41
42
  # @return [TriggerWorkflowViaPostResponse]
42
- def trigger_workflow(account_id, body, options = DocuSign_Maestro::TriggerWorkflowOptions.default)
43
- data, _status_code, _headers = trigger_workflow_with_http_info(account_id, body, options)
43
+ def trigger_workflow(account_id, workflow_definition_id, body, options = DocuSign_Maestro::TriggerWorkflowOptions.default)
44
+ data, _status_code, _headers = trigger_workflow_with_http_info(account_id, workflow_definition_id, body, options)
44
45
  return data
45
46
  end
46
47
 
47
48
  # Creates a new workflow instance after authenticating with DS Account Server
48
49
  # Creates a new workflow instance after authenticating with DS Account Server
49
50
  # @param account_id Account ID
51
+ # @param workflow_definition_id Workflow Definition ID
50
52
  # @param body JSON payload that will be passed to the triggered workflow
51
53
  # @param DocuSign_Maestro::TriggerWorkflowOptions Options for modifying the behavior of the function.
52
54
  # @return [Array<(TriggerWorkflowViaPostResponse, Fixnum, Hash)>] TriggerWorkflowViaPostResponse data, response status code and response headers
53
- def trigger_workflow_with_http_info(account_id, body, options = DocuSign_Maestro::TriggerWorkflowOptions.default)
55
+ def trigger_workflow_with_http_info(account_id, workflow_definition_id, body, options = DocuSign_Maestro::TriggerWorkflowOptions.default)
54
56
  if @api_client.config.debugging
55
57
  @api_client.config.logger.debug "Calling API: WorkflowTriggerApi.trigger_workflow ..."
56
58
  end
57
59
  # verify the required parameter 'account_id' is set
58
60
  fail ArgumentError, "Missing the required parameter 'account_id' when calling WorkflowTriggerApi.trigger_workflow" if account_id.nil?
61
+ # verify the required parameter 'workflow_definition_id' is set
62
+ fail ArgumentError, "Missing the required parameter 'workflow_definition_id' when calling WorkflowTriggerApi.trigger_workflow" if workflow_definition_id.nil?
59
63
  # verify the required parameter 'body' is set
60
64
  fail ArgumentError, "Missing the required parameter 'body' when calling WorkflowTriggerApi.trigger_workflow" if body.nil?
61
65
  # resource path
62
- local_var_path = "aow-auth/v1.0/accounts/{accountId}/workflows/trigger".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
66
+ local_var_path = "/v1/accounts/{accountId}/workflow_definitions/{workflowDefinitionId}/trigger".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'workflowDefinitionId' + '}', workflow_definition_id.to_s)
63
67
 
64
68
  # query parameters
65
69
  query_params = {}
data/lib/docusign_maestro/client/api_client.rb CHANGED
@@ -35,7 +35,7 @@ module DocuSign_Maestro
35
35
  # @option config [Configuration] Configuration for initializing the object, default to Configuration.default
36
36
  def initialize(config = Configuration.default)
37
37
  @config = config
38
- @user_agent = "Swagger-Codegen/1.0.0/1.0.0.rc1/ruby-#{RUBY_VERSION}p#{RUBY_PATCHLEVEL}"
38
+ @user_agent = "Swagger-Codegen/1.0.0/2.0.0.rc1/ruby-#{RUBY_VERSION}p#{RUBY_PATCHLEVEL}"
39
39
  @default_headers = {
40
40
  'Content-Type' => "application/json",
41
41
  'User-Agent' => @user_agent
data/lib/docusign_maestro/configuration.rb CHANGED
@@ -124,8 +124,8 @@ module DocuSign_Maestro
124
124
 
125
125
  def initialize
126
126
  @scheme = 'https'
127
- @host = 'www.docusign.net'
128
- @base_path = '/'
127
+ @host = 'apps.docusign.com'
128
+ @base_path = '/api/maestro'
129
129
  @api_key = {}
130
130
  @api_key_prefix = {}
131
131
  @timeout = 0
data/lib/docusign_maestro/models/deployment_status.rb CHANGED
@@ -20,6 +20,8 @@ module DocuSign_Maestro
20
20
  DELETE_IN_PROGRESS = 'Delete in Progress'.freeze
21
21
  DELETED = 'Deleted'.freeze
22
22
  NOT_DEPLOYED = 'Not Deployed'.freeze
23
+ UNPUBLISH_IN_PROGRESS = 'Unpublish in Progress'.freeze
24
+ UNPUBLISHED = 'Unpublished'.freeze
23
25
 
24
26
  # Builds the enum from string
25
27
  # @param [String] The enum value in the form of the string
data/lib/docusign_maestro/models/ds_workflow_variable_from_participant.rb CHANGED
@@ -12,29 +12,17 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
12
12
  require 'date'
13
13
 
14
14
  module DocuSign_Maestro
15
- # DS Workflow Variable from a Participant
15
+ # DS Workflow Variable from a Participant object. The definition is flexible based on the workflow definition.
16
16
  class DSWorkflowVariableFromParticipant
17
- attr_accessor :key
18
-
19
- attr_accessor :participant_id
20
-
21
- attr_accessor :source
22
-
23
17
  # Attribute mapping from ruby-style variable name to JSON key.
24
18
  def self.attribute_map
25
19
  {
26
- :'key' => :'key',
27
- :'participant_id' => :'participantId',
28
- :'source' => :'source'
29
20
  }
30
21
  end
31
22
 
32
23
  # Attribute type mapping.
33
24
  def self.swagger_types
34
25
  {
35
- :'key' => :'ParticipantKeys',
36
- :'participant_id' => :'String',
37
- :'source' => :'DSWorkflowVariableSourceTypesParticipant'
38
26
  }
39
27
  end
40
28
 
@@ -45,45 +33,18 @@ module DocuSign_Maestro
45
33
 
46
34
  # convert string to symbol for hash key
47
35
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
48
-
49
- if attributes.has_key?(:'key')
50
- self.key = attributes[:'key']
51
- end
52
-
53
- if attributes.has_key?(:'participantId')
54
- self.participant_id = attributes[:'participantId']
55
- end
56
-
57
- if attributes.has_key?(:'source')
58
- self.source = attributes[:'source']
59
- end
60
36
  end
61
37
 
62
38
  # Show invalid properties with the reasons. Usually used together with valid?
63
39
  # @return Array for valid properties with the reasons
64
40
  def list_invalid_properties
65
41
  invalid_properties = Array.new
66
- if @key.nil?
67
- invalid_properties.push('invalid value for "key", key cannot be nil.')
68
- end
69
-
70
- if @participant_id.nil?
71
- invalid_properties.push('invalid value for "participant_id", participant_id cannot be nil.')
72
- end
73
-
74
- if @source.nil?
75
- invalid_properties.push('invalid value for "source", source cannot be nil.')
76
- end
77
-
78
42
  invalid_properties
79
43
  end
80
44
 
81
45
  # Check to see if the all the properties in the model are valid
82
46
  # @return true if the model is valid
83
47
  def valid?
84
- return false if @key.nil?
85
- return false if @participant_id.nil?
86
- return false if @source.nil?
87
48
  true
88
49
  end
89
50
 
@@ -91,10 +52,7 @@ module DocuSign_Maestro
91
52
  # @param [Object] Object to be compared
92
53
  def ==(o)
93
54
  return true if self.equal?(o)
94
- self.class == o.class &&
95
- key == o.key &&
96
- participant_id == o.participant_id &&
97
- source == o.source
55
+ self.class == o.class
98
56
  end
99
57
 
100
58
  # @see the `==` method
@@ -106,7 +64,7 @@ module DocuSign_Maestro
106
64
  # Calculates hash code according to all attributes.
107
65
  # @return [Fixnum] Hash code
108
66
  def hash
109
- [key, participant_id, source].hash
67
+ [].hash
110
68
  end
111
69
 
112
70
  # Builds the object from hash
data/lib/docusign_maestro/models/error_codes.rb CHANGED
@@ -28,6 +28,7 @@ module DocuSign_Maestro
28
28
  N10202 = 'ERR_10202'.freeze
29
29
  N10301 = 'ERR_10301'.freeze
30
30
  N10302 = 'ERR_10302'.freeze
31
+ N10401 = 'ERR_10401'.freeze
31
32
  N10801 = 'ERR_10801'.freeze
32
33
  N10802 = 'ERR_10802'.freeze
33
34
  N10999 = 'ERR_10999'.freeze
data/lib/docusign_maestro/models/event_types.rb CHANGED
@@ -14,6 +14,19 @@ require 'date'
14
14
  module DocuSign_Maestro
15
15
  class EventTypes
16
16
 
17
+ ENVELOPE_SENT = 'envelope-sent'.freeze
18
+ ENVELOPE_DELIVERED = 'envelope-delivered'.freeze
19
+ ENVELOPE_COMPLETED = 'envelope-completed'.freeze
20
+ ENVELOPE_DECLINED = 'envelope-declined'.freeze
21
+ ENVELOPE_VOIDED = 'envelope-voided'.freeze
22
+ ENVELOPE_CREATED = 'envelope-created'.freeze
23
+ ENVELOPE_RESENT = 'envelope-resent'.freeze
24
+ ENVELOPE_CORRECTED = 'envelope-corrected'.freeze
25
+ ENVELOPE_PURGE = 'envelope-purge'.freeze
26
+ ENVELOPE_DELETED = 'envelope-deleted'.freeze
27
+ ENVELOPE_DISCARD = 'envelope-discard'.freeze
28
+ DELIVERY_FAILED = 'Delivery Failed'.freeze
29
+ AUTHENTICATION_FAILED = 'Authentication Failed'.freeze
17
30
  SENT = 'Sent'.freeze
18
31
  DELIVERED = 'Delivered'.freeze
19
32
  SIGNED = 'Signed'.freeze
data/lib/docusign_maestro/models/started_by_instance.rb CHANGED
@@ -92,7 +92,7 @@ module DocuSign_Maestro
92
92
  # Check to see if the all the properties in the model are valid
93
93
  # @return true if the model is valid
94
94
  def valid?
95
- started_by_type_validator = EnumAttributeValidator.new('String', ['Anonymous', 'Preparer', 'Participant'])
95
+ started_by_type_validator = EnumAttributeValidator.new('String', ['Anonymous', 'Preparer', 'Participant', 'OnBehalfOf'])
96
96
  return false unless started_by_type_validator.valid?(@started_by_type)
97
97
  true
98
98
  end
@@ -100,7 +100,7 @@ module DocuSign_Maestro
100
100
  # Custom attribute writer method checking allowed values (enum).
101
101
  # @param [Object] started_by_type Object to be assigned
102
102
  def started_by_type=(started_by_type)
103
- validator = EnumAttributeValidator.new('String', ['Anonymous', 'Preparer', 'Participant'])
103
+ validator = EnumAttributeValidator.new('String', ['Anonymous', 'Preparer', 'Participant', 'OnBehalfOf'])
104
104
  unless validator.valid?(started_by_type)
105
105
  fail ArgumentError, 'invalid value for "started_by_type", must be one of #{validator.allowable_values}.'
106
106
  end
data/lib/docusign_maestro/models/workflow_instance.rb CHANGED
@@ -37,6 +37,7 @@ module DocuSign_Maestro
37
37
 
38
38
  attr_accessor :template_id
39
39
 
40
+ # Contains the list of Users and Steps mapping
40
41
  attr_accessor :users
41
42
 
42
43
  # Attribute mapping from ruby-style variable name to JSON key.
data/lib/docusign_maestro/models/workflow_instance_state.rb CHANGED
@@ -14,9 +14,11 @@ require 'date'
14
14
  module DocuSign_Maestro
15
15
  class WorkflowInstanceState
16
16
 
17
+ CREATED = 'Created'.freeze
17
18
  IN_PROGRESS = 'In Progress'.freeze
18
19
  COMPLETED = 'Completed'.freeze
19
20
  FAILED = 'Failed'.freeze
21
+ CANCELED = 'Canceled'.freeze
20
22
 
21
23
  # Builds the enum from string
22
24
  # @param [String] The enum value in the form of the string
data/lib/docusign_maestro/models/workflow_step_history_state.rb CHANGED
@@ -17,6 +17,7 @@ module DocuSign_Maestro
17
17
  IN_PROGRESS = 'In Progress'.freeze
18
18
  COMPLETED = 'Completed'.freeze
19
19
  FAILED = 'Failed'.freeze
20
+ CANCELED = 'Canceled'.freeze
20
21
 
21
22
  # Builds the enum from string
22
23
  # @param [String] The enum value in the form of the string
data/lib/docusign_maestro/version.rb CHANGED
@@ -10,5 +10,5 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
10
10
  =end
11
11
 
12
12
  module DocuSign_Maestro
13
- VERSION = '1.0.0.rc1'
13
+ VERSION = '2.0.0.rc1'
14
14
  end
data/lib/docusign_maestro.rb CHANGED
@@ -81,7 +81,6 @@ require 'docusign_maestro/models/ds_workflow_variable_from_participant'
81
81
  require 'docusign_maestro/models/ds_workflow_variable_from_step'
82
82
  require 'docusign_maestro/models/ds_workflow_variable_from_variable'
83
83
  require 'docusign_maestro/models/ds_workflow_variable_record'
84
- require 'docusign_maestro/models/ds_workflow_variable_source_types_participant'
85
84
  require 'docusign_maestro/models/ds_workflow_variable_source_types_step'
86
85
  require 'docusign_maestro/models/ds_workflow_variable_source_types_variable'
87
86
  require 'docusign_maestro/models/deploy_request'
@@ -108,7 +107,6 @@ require 'docusign_maestro/models/invalid_workflow_response'
108
107
  require 'docusign_maestro/models/new_or_updated_workflow_definition_response'
109
108
  require 'docusign_maestro/models/number_or_variable'
110
109
  require 'docusign_maestro/models/participant'
111
- require 'docusign_maestro/models/participant_keys'
112
110
  require 'docusign_maestro/models/progress_instance'
113
111
  require 'docusign_maestro/models/record_string_boolean'
114
112
  require 'docusign_maestro/models/record_string_or_variable_or_transformation'
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: docusign_maestro
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.0.0.rc1
4
+ version: 2.0.0.rc1
5
5
  platform: ruby
6
6
  authors:
7
7
  - DocuSign
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2024-04-03 00:00:00.000000000 Z
11
+ date: 2024-06-14 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: jwt