docusign_webforms 1.0.0 → 2.0.0.rc1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +8 -0
- data/README.md +94 -131
- data/docusign_webforms.gemspec +1 -1
- data/lib/docusign_webforms/api/form_instance_management_api.rb +4 -4
- data/lib/docusign_webforms/api/form_management_api.rb +2 -2
- data/lib/docusign_webforms/client/api_client.rb +7 -9
- data/lib/docusign_webforms/client/auth/oauth.rb +0 -2
- data/lib/docusign_webforms/configuration.rb +4 -4
- data/lib/docusign_webforms/models/instance_source.rb +1 -0
- data/lib/docusign_webforms/models/instance_status.rb +1 -0
- data/lib/docusign_webforms/models/web_form.rb +11 -1
- data/lib/docusign_webforms/models/web_form_metadata.rb +22 -2
- data/lib/docusign_webforms/models/web_form_source.rb +1 -0
- data/lib/docusign_webforms/models/web_form_summary.rb +11 -1
- data/lib/docusign_webforms/models/web_form_type.rb +29 -0
- data/lib/docusign_webforms/version.rb +1 -1
- data/lib/docusign_webforms.rb +1 -0
- data/tests/Gemfile +1 -0
- data/tests/docs/private.pem +1 -0
- data/tests/spec/unit_tests_using_jwt_spec.rb +551 -26
- metadata +7 -5
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 9b1642132527e05f85e512329d0cedc6e9659a760bc7bc705c92eb67cfe5feca
|
|
4
|
+
data.tar.gz: f8c386cdeb0ad54f02da2a305a45cdc2c7b4c44d27891b1fb7b51a9054a670be
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 6c3b1fdf0a6acd269c96533b6ce21a9fd6cb2206430bb0f45e9c706a4e5b006d80cbb23b11bbe0dc0268fb2e54d902d3cac5da4a1d4f98e4351753fccd88d25b
|
|
7
|
+
data.tar.gz: 947cb41469d02f3d4a1e5f0e99e62b24db7c784b7e2c8f1f8d3e8c8fed469dda635412a90e6c51b9f932c2209cdbd5763b61eb402516a67e05b2696e5b1af706
|
data/CHANGELOG.md
CHANGED
|
@@ -1,3 +1,11 @@
|
|
|
1
|
+
## [v2.0.0.rc1] - WebForms API v1.1.0-1.0.4 - 2024-09-24
|
|
2
|
+
### Changed
|
|
3
|
+
- Added support for version v1.1.0-1.0.4 of the DocuSign WebForms API.
|
|
4
|
+
- Updated the SDK release version.
|
|
5
|
+
|
|
6
|
+
## Important Action Required
|
|
7
|
+
- User needs to update the base URL in your codebase (if passing to SDK explicitly) and remove the /v1.1 component at the end of the URL for the SDK to work properly with this release.
|
|
8
|
+
|
|
1
9
|
## [v1.0.0] - WebForms API v1.1.0-1.0.2 - 2024-02-14
|
|
2
10
|
## Version 1.0.0 (Initial Release)
|
|
3
11
|
- Introducing the SDK based on the OpenAPI specification of DocuSign WebForms APIs.
|
data/README.md
CHANGED
|
@@ -1,132 +1,95 @@
|
|
|
1
|
-
#
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
1
|
+
# The Official Docusign WebForms 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 Web Forms in your agreement processes. Enjoy greater flexibility to manage forms using your own code including the creation and management of form instances with prefilled data. This API works with Docusign JS to enable the embedding of a web form instance in your web application.
|
|
25
|
+
|
|
26
|
+
<a id="installation"></a>
|
|
14
27
|
## Installation
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
## Documentation for API Endpoints
|
|
84
|
-
|
|
85
|
-
All URIs are relative to *https://www.docusign.net/webforms/v1.1*
|
|
86
|
-
|
|
87
|
-
Class | Method | HTTP request | Description
|
|
88
|
-
------------ | ------------- | ------------- | -------------
|
|
89
|
-
*DocuSign_WebForms::FormInstanceManagementApi* | [**create_instance**](docs/FormInstanceManagementApi.md#create_instance) | **POST** /accounts/{account_id}/forms/{form_id}/instances | Creates an instance of the web form
|
|
90
|
-
*DocuSign_WebForms::FormInstanceManagementApi* | [**get_instance**](docs/FormInstanceManagementApi.md#get_instance) | **GET** /accounts/{account_id}/forms/{form_id}/instances/{instance_id} | Get form instance
|
|
91
|
-
*DocuSign_WebForms::FormInstanceManagementApi* | [**list_instances**](docs/FormInstanceManagementApi.md#list_instances) | **GET** /accounts/{account_id}/forms/{form_id}/instances | List instances
|
|
92
|
-
*DocuSign_WebForms::FormInstanceManagementApi* | [**refresh_token**](docs/FormInstanceManagementApi.md#refresh_token) | **POST** /accounts/{account_id}/forms/{form_id}/instances/{instance_id}/refresh | Refreshes the instance token
|
|
93
|
-
*DocuSign_WebForms::FormManagementApi* | [**get_form**](docs/FormManagementApi.md#get_form) | **GET** /accounts/{account_id}/forms/{form_id} | Get Form
|
|
94
|
-
*DocuSign_WebForms::FormManagementApi* | [**list_forms**](docs/FormManagementApi.md#list_forms) | **GET** /accounts/{account_id}/forms | List Forms
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
## Documentation for Models
|
|
98
|
-
|
|
99
|
-
- [DocuSign_WebForms::AuthenticationMethod](docs/AuthenticationMethod.md)
|
|
100
|
-
- [DocuSign_WebForms::CreateInstanceRequestBody](docs/CreateInstanceRequestBody.md)
|
|
101
|
-
- [DocuSign_WebForms::HttpError](docs/HttpError.md)
|
|
102
|
-
- [DocuSign_WebForms::HttpSuccess](docs/HttpSuccess.md)
|
|
103
|
-
- [DocuSign_WebForms::InstanceSource](docs/InstanceSource.md)
|
|
104
|
-
- [DocuSign_WebForms::InstanceStatus](docs/InstanceStatus.md)
|
|
105
|
-
- [DocuSign_WebForms::TemplateProperties](docs/TemplateProperties.md)
|
|
106
|
-
- [DocuSign_WebForms::WebForm](docs/WebForm.md)
|
|
107
|
-
- [DocuSign_WebForms::WebFormComponentType](docs/WebFormComponentType.md)
|
|
108
|
-
- [DocuSign_WebForms::WebFormContent](docs/WebFormContent.md)
|
|
109
|
-
- [DocuSign_WebForms::WebFormInstance](docs/WebFormInstance.md)
|
|
110
|
-
- [DocuSign_WebForms::WebFormInstanceEnvelopes](docs/WebFormInstanceEnvelopes.md)
|
|
111
|
-
- [DocuSign_WebForms::WebFormInstanceList](docs/WebFormInstanceList.md)
|
|
112
|
-
- [DocuSign_WebForms::WebFormInstanceMetadata](docs/WebFormInstanceMetadata.md)
|
|
113
|
-
- [DocuSign_WebForms::WebFormMetadata](docs/WebFormMetadata.md)
|
|
114
|
-
- [DocuSign_WebForms::WebFormProperties](docs/WebFormProperties.md)
|
|
115
|
-
- [DocuSign_WebForms::WebFormSource](docs/WebFormSource.md)
|
|
116
|
-
- [DocuSign_WebForms::WebFormState](docs/WebFormState.md)
|
|
117
|
-
- [DocuSign_WebForms::WebFormSummary](docs/WebFormSummary.md)
|
|
118
|
-
- [DocuSign_WebForms::WebFormSummaryList](docs/WebFormSummaryList.md)
|
|
119
|
-
- [DocuSign_WebForms::WebFormUserInfo](docs/WebFormUserInfo.md)
|
|
120
|
-
- [DocuSign_WebForms::WebFormValues](docs/WebFormValues.md)
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
## Documentation for Authorization
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
### docusignAccessCode
|
|
127
|
-
|
|
128
|
-
- **Type**: OAuth
|
|
129
|
-
- **Flow**: accessCode
|
|
130
|
-
- **Authorization URL**: https://account.docusign.com/oauth/auth
|
|
131
|
-
- **Scopes**: N/A
|
|
132
|
-
|
|
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/web-forms-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.1.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_webforms'`
|
|
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_webforms**
|
|
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/web-forms-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 WebForms 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-webforms-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 WebForms Ruby Client SDK is licensed under the [MIT License](https://github.com/docusign/docusign-webforms-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/docusign_webforms.gemspec
CHANGED
|
@@ -22,7 +22,7 @@ Gem::Specification.new do |s|
|
|
|
22
22
|
s.email = ["devcenter@docusign.com"]
|
|
23
23
|
s.homepage = "https://github.com/docusign/docusign-webforms-ruby-client"
|
|
24
24
|
s.summary = "Web Forms API version 1.1 Ruby Gem"
|
|
25
|
-
s.description = "The
|
|
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-webforms-ruby-client repository."
|
|
26
26
|
s.license = "MIT"
|
|
27
27
|
s.required_ruby_version = ">= 1.9"
|
|
28
28
|
|
|
@@ -58,7 +58,7 @@ module DocuSign_WebForms
|
|
|
58
58
|
# verify the required parameter 'create_instance_body' is set
|
|
59
59
|
fail ArgumentError, "Missing the required parameter 'create_instance_body' when calling FormInstanceManagementApi.create_instance" if create_instance_body.nil?
|
|
60
60
|
# resource path
|
|
61
|
-
local_var_path = "/accounts/{
|
|
61
|
+
local_var_path = "/v1.1/accounts/{accountId}/forms/{formId}/instances".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'formId' + '}', form_id.to_s)
|
|
62
62
|
|
|
63
63
|
# query parameters
|
|
64
64
|
query_params = {}
|
|
@@ -117,7 +117,7 @@ module DocuSign_WebForms
|
|
|
117
117
|
# verify the required parameter 'instance_id' is set
|
|
118
118
|
fail ArgumentError, "Missing the required parameter 'instance_id' when calling FormInstanceManagementApi.get_instance" if instance_id.nil?
|
|
119
119
|
# resource path
|
|
120
|
-
local_var_path = "/accounts/{
|
|
120
|
+
local_var_path = "/v1.1/accounts/{accountId}/forms/{formId}/instances/{instanceId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'formId' + '}', form_id.to_s).sub('{' + 'instanceId' + '}', instance_id.to_s)
|
|
121
121
|
|
|
122
122
|
# query parameters
|
|
123
123
|
query_params = {}
|
|
@@ -178,7 +178,7 @@ module DocuSign_WebForms
|
|
|
178
178
|
end
|
|
179
179
|
|
|
180
180
|
# resource path
|
|
181
|
-
local_var_path = "/accounts/{
|
|
181
|
+
local_var_path = "/v1.1/accounts/{accountId}/forms/{formId}/instances".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'formId' + '}', form_id.to_s)
|
|
182
182
|
|
|
183
183
|
# query parameters
|
|
184
184
|
query_params = {}
|
|
@@ -238,7 +238,7 @@ module DocuSign_WebForms
|
|
|
238
238
|
# verify the required parameter 'instance_id' is set
|
|
239
239
|
fail ArgumentError, "Missing the required parameter 'instance_id' when calling FormInstanceManagementApi.refresh_token" if instance_id.nil?
|
|
240
240
|
# resource path
|
|
241
|
-
local_var_path = "/accounts/{
|
|
241
|
+
local_var_path = "/v1.1/accounts/{accountId}/forms/{formId}/instances/{instanceId}/refresh".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'formId' + '}', form_id.to_s).sub('{' + 'instanceId' + '}', instance_id.to_s)
|
|
242
242
|
|
|
243
243
|
# query parameters
|
|
244
244
|
query_params = {}
|
|
@@ -90,7 +90,7 @@ module DocuSign_WebForms
|
|
|
90
90
|
end
|
|
91
91
|
|
|
92
92
|
# resource path
|
|
93
|
-
local_var_path = "/accounts/{
|
|
93
|
+
local_var_path = "/v1.1/accounts/{accountId}/forms/{formId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'formId' + '}', form_id.to_s)
|
|
94
94
|
|
|
95
95
|
# query parameters
|
|
96
96
|
query_params = {}
|
|
@@ -151,7 +151,7 @@ module DocuSign_WebForms
|
|
|
151
151
|
end
|
|
152
152
|
|
|
153
153
|
# resource path
|
|
154
|
-
local_var_path = "/accounts/{
|
|
154
|
+
local_var_path = "/v1.1/accounts/{accountId}/forms".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
|
155
155
|
|
|
156
156
|
# query parameters
|
|
157
157
|
query_params = {}
|
|
@@ -35,7 +35,7 @@ module DocuSign_WebForms
|
|
|
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.1.0/
|
|
38
|
+
@user_agent = "Swagger-Codegen/1.1.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
|
|
@@ -409,8 +409,6 @@ module DocuSign_WebForms
|
|
|
409
409
|
# Derive OAuth Base Path if not given
|
|
410
410
|
if self.base_path.nil? or self.base_path.start_with?("https://demo") or self.base_path.start_with?("http://demo") or self.base_path.start_with?("https://apps-d") or self.base_path.start_with?("http://apps-d")
|
|
411
411
|
self.oauth_base_path = OAuth::DEMO_OAUTH_BASE_PATH
|
|
412
|
-
elsif self.base_path.start_with?("https://stage") or self.base_path.start_with?("http://stage") or self.base_path.start_with?("https://apps-s") or self.base_path.start_with?("http://apps-s")
|
|
413
|
-
self.oauth_base_path = OAuth::STAGE_OAUTH_BASE_PATH
|
|
414
412
|
else
|
|
415
413
|
self.oauth_base_path = OAuth::PRODUCTION_OAUTH_BASE_PATH
|
|
416
414
|
end
|
|
@@ -426,7 +424,7 @@ module DocuSign_WebForms
|
|
|
426
424
|
end
|
|
427
425
|
|
|
428
426
|
# Helper method to configure the OAuth accessCode/implicit flow parameters
|
|
429
|
-
# @param [String] client_id
|
|
427
|
+
# @param [String] client_id Docusign OAuth Client Id(AKA Integrator Key)
|
|
430
428
|
# @param scopes The list of requested scopes. Client applications may be scoped to a limited set of system access.
|
|
431
429
|
# @param [String] redirect_uri This determines where to deliver the response containing the authorization code
|
|
432
430
|
# @param [String] response_type Determines the response type of the authorization request, NOTE: these response types are mutually exclusive for a client application. A public/native client application may only request a response type
|
|
@@ -446,8 +444,8 @@ module DocuSign_WebForms
|
|
|
446
444
|
end
|
|
447
445
|
|
|
448
446
|
# Request JWT User Token
|
|
449
|
-
# @param [String] client_id
|
|
450
|
-
# @param [String] user_id
|
|
447
|
+
# @param [String] client_id Docusign OAuth Client Id(AKA Integrator Key)
|
|
448
|
+
# @param [String] user_id Docusign user Id to be impersonated
|
|
451
449
|
# @param [String] private_key_or_filename the RSA private key
|
|
452
450
|
# @param [Number] expires_in number of seconds remaining before the JWT assertion is considered as invalid
|
|
453
451
|
# @param scopes The list of requested scopes. Client applications may be scoped to a limited set of system access.
|
|
@@ -497,7 +495,7 @@ module DocuSign_WebForms
|
|
|
497
495
|
end
|
|
498
496
|
|
|
499
497
|
# Request JWT User Token
|
|
500
|
-
# @param [String] client_id
|
|
498
|
+
# @param [String] client_id Docusign OAuth Client Id(AKA Integrator Key)
|
|
501
499
|
# @param [String] private_key_or_filename the RSA private key
|
|
502
500
|
# @param [Number] expires_in number of seconds remaining before the JWT assertion is considered as invalid
|
|
503
501
|
# @param scopes The list of requested scopes. Client applications may be scoped to a limited set of system access.
|
|
@@ -559,8 +557,8 @@ module DocuSign_WebForms
|
|
|
559
557
|
end
|
|
560
558
|
|
|
561
559
|
# GenerateAccessToken will exchange the authorization code for an access token and refresh tokens.
|
|
562
|
-
# @param [String] client_id
|
|
563
|
-
# @param [String] client_secret The secret key you generated when you set up the integration in
|
|
560
|
+
# @param [String] client_id Docusign OAuth Client Id(AKA Integrator Key)
|
|
561
|
+
# @param [String] client_secret The secret key you generated when you set up the integration in Docusign Admin console.
|
|
564
562
|
# @param [String] code The authorization code
|
|
565
563
|
def generate_access_token(client_id, client_secret, code)
|
|
566
564
|
raise ArgumentError.new('client_id cannot be empty') if client_id.empty?
|
|
@@ -14,8 +14,6 @@ module DocuSign_WebForms
|
|
|
14
14
|
DEMO_OAUTH_BASE_PATH = "account-d.docusign.com"
|
|
15
15
|
# Production server base path
|
|
16
16
|
PRODUCTION_OAUTH_BASE_PATH = "account.docusign.com"
|
|
17
|
-
# Stage server base path
|
|
18
|
-
STAGE_OAUTH_BASE_PATH = "account-s.docusign.com"
|
|
19
17
|
# JWT Grant Type
|
|
20
18
|
GRANT_TYPE_JWT = "urn:ietf:params:oauth:grant-type:jwt-bearer"
|
|
21
19
|
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#Web Forms API version 1.1
|
|
3
3
|
|
|
4
|
-
#The Web Forms API facilitates generating semantic HTML forms around everyday contracts.
|
|
4
|
+
#The Web Forms API facilitates generating semantic HTML forms around everyday contracts.
|
|
5
5
|
|
|
6
6
|
OpenAPI spec version: 1.1.0
|
|
7
7
|
Contact: devcenter@docusign.com
|
|
@@ -124,8 +124,8 @@ module DocuSign_WebForms
|
|
|
124
124
|
|
|
125
125
|
def initialize
|
|
126
126
|
@scheme = 'https'
|
|
127
|
-
@host = 'apps-d.docusign.com
|
|
128
|
-
@base_path = '/webforms
|
|
127
|
+
@host = 'apps-d.docusign.com'
|
|
128
|
+
@base_path = '/api/webforms'
|
|
129
129
|
@api_key = {}
|
|
130
130
|
@api_key_prefix = {}
|
|
131
131
|
@timeout = 0
|
|
@@ -200,4 +200,4 @@ module DocuSign_WebForms
|
|
|
200
200
|
}
|
|
201
201
|
end
|
|
202
202
|
end
|
|
203
|
-
end
|
|
203
|
+
end
|
|
@@ -18,6 +18,7 @@ module DocuSign_WebForms
|
|
|
18
18
|
API_EMBEDDED = 'API_EMBEDDED'.freeze
|
|
19
19
|
API_REMOTE = 'API_REMOTE'.freeze
|
|
20
20
|
UI_REMOTE = 'UI_REMOTE'.freeze
|
|
21
|
+
WORKFLOW = 'WORKFLOW'.freeze
|
|
21
22
|
|
|
22
23
|
# Builds the enum from string
|
|
23
24
|
# @param [String] The enum value in the form of the string
|
|
@@ -24,6 +24,9 @@ module DocuSign_WebForms
|
|
|
24
24
|
# Is the form currently enabled and available for data collection
|
|
25
25
|
attr_accessor :is_enabled
|
|
26
26
|
|
|
27
|
+
# Has the form created through upload
|
|
28
|
+
attr_accessor :is_uploaded
|
|
29
|
+
|
|
27
30
|
# Does the form have draft changes that need to be published?
|
|
28
31
|
attr_accessor :has_draft_changes
|
|
29
32
|
|
|
@@ -44,6 +47,7 @@ module DocuSign_WebForms
|
|
|
44
47
|
:'account_id' => :'accountId',
|
|
45
48
|
:'is_published' => :'isPublished',
|
|
46
49
|
:'is_enabled' => :'isEnabled',
|
|
50
|
+
:'is_uploaded' => :'isUploaded',
|
|
47
51
|
:'has_draft_changes' => :'hasDraftChanges',
|
|
48
52
|
:'form_state' => :'formState',
|
|
49
53
|
:'form_properties' => :'formProperties',
|
|
@@ -60,6 +64,7 @@ module DocuSign_WebForms
|
|
|
60
64
|
:'account_id' => :'String',
|
|
61
65
|
:'is_published' => :'BOOLEAN',
|
|
62
66
|
:'is_enabled' => :'BOOLEAN',
|
|
67
|
+
:'is_uploaded' => :'BOOLEAN',
|
|
63
68
|
:'has_draft_changes' => :'BOOLEAN',
|
|
64
69
|
:'form_state' => :'WebFormState',
|
|
65
70
|
:'form_properties' => :'WebFormProperties',
|
|
@@ -93,6 +98,10 @@ module DocuSign_WebForms
|
|
|
93
98
|
self.is_enabled = attributes[:'isEnabled']
|
|
94
99
|
end
|
|
95
100
|
|
|
101
|
+
if attributes.has_key?(:'isUploaded')
|
|
102
|
+
self.is_uploaded = attributes[:'isUploaded']
|
|
103
|
+
end
|
|
104
|
+
|
|
96
105
|
if attributes.has_key?(:'hasDraftChanges')
|
|
97
106
|
self.has_draft_changes = attributes[:'hasDraftChanges']
|
|
98
107
|
end
|
|
@@ -140,6 +149,7 @@ module DocuSign_WebForms
|
|
|
140
149
|
account_id == o.account_id &&
|
|
141
150
|
is_published == o.is_published &&
|
|
142
151
|
is_enabled == o.is_enabled &&
|
|
152
|
+
is_uploaded == o.is_uploaded &&
|
|
143
153
|
has_draft_changes == o.has_draft_changes &&
|
|
144
154
|
form_state == o.form_state &&
|
|
145
155
|
form_properties == o.form_properties &&
|
|
@@ -157,7 +167,7 @@ module DocuSign_WebForms
|
|
|
157
167
|
# Calculates hash code according to all attributes.
|
|
158
168
|
# @return [Fixnum] Hash code
|
|
159
169
|
def hash
|
|
160
|
-
[id, account_id, is_published, is_enabled, has_draft_changes, form_state, form_properties, form_metadata, version_id, form_content].hash
|
|
170
|
+
[id, account_id, is_published, is_enabled, is_uploaded, has_draft_changes, form_state, form_properties, form_metadata, version_id, form_content].hash
|
|
161
171
|
end
|
|
162
172
|
|
|
163
173
|
# Builds the object from hash
|
|
@@ -14,9 +14,15 @@ require 'date'
|
|
|
14
14
|
module DocuSign_WebForms
|
|
15
15
|
# Form metadata
|
|
16
16
|
class WebFormMetadata
|
|
17
|
-
# The source from which the webform is created. Accepted values are [
|
|
17
|
+
# The source from which the webform is created. Accepted values are [templates, blank, form]
|
|
18
18
|
attr_accessor :source
|
|
19
19
|
|
|
20
|
+
# Represents webform type. Possible values are [standalone, hasEsignTemplate]
|
|
21
|
+
attr_accessor :type
|
|
22
|
+
|
|
23
|
+
# The source form id from which the webform is created.
|
|
24
|
+
attr_accessor :source_form_id
|
|
25
|
+
|
|
20
26
|
# The user that created the form or has been transferred ownership
|
|
21
27
|
attr_accessor :owner
|
|
22
28
|
|
|
@@ -78,6 +84,8 @@ module DocuSign_WebForms
|
|
|
78
84
|
def self.attribute_map
|
|
79
85
|
{
|
|
80
86
|
:'source' => :'source',
|
|
87
|
+
:'type' => :'type',
|
|
88
|
+
:'source_form_id' => :'sourceFormId',
|
|
81
89
|
:'owner' => :'owner',
|
|
82
90
|
:'sender' => :'sender',
|
|
83
91
|
:'last_modified_by' => :'lastModifiedBy',
|
|
@@ -104,6 +112,8 @@ module DocuSign_WebForms
|
|
|
104
112
|
def self.swagger_types
|
|
105
113
|
{
|
|
106
114
|
:'source' => :'WebFormSource',
|
|
115
|
+
:'type' => :'WebFormType',
|
|
116
|
+
:'source_form_id' => :'String',
|
|
107
117
|
:'owner' => :'WebFormUserInfo',
|
|
108
118
|
:'sender' => :'WebFormUserInfo',
|
|
109
119
|
:'last_modified_by' => :'WebFormUserInfo',
|
|
@@ -138,6 +148,14 @@ module DocuSign_WebForms
|
|
|
138
148
|
self.source = attributes[:'source']
|
|
139
149
|
end
|
|
140
150
|
|
|
151
|
+
if attributes.has_key?(:'type')
|
|
152
|
+
self.type = attributes[:'type']
|
|
153
|
+
end
|
|
154
|
+
|
|
155
|
+
if attributes.has_key?(:'sourceFormId')
|
|
156
|
+
self.source_form_id = attributes[:'sourceFormId']
|
|
157
|
+
end
|
|
158
|
+
|
|
141
159
|
if attributes.has_key?(:'owner')
|
|
142
160
|
self.owner = attributes[:'owner']
|
|
143
161
|
end
|
|
@@ -236,6 +254,8 @@ module DocuSign_WebForms
|
|
|
236
254
|
return true if self.equal?(o)
|
|
237
255
|
self.class == o.class &&
|
|
238
256
|
source == o.source &&
|
|
257
|
+
type == o.type &&
|
|
258
|
+
source_form_id == o.source_form_id &&
|
|
239
259
|
owner == o.owner &&
|
|
240
260
|
sender == o.sender &&
|
|
241
261
|
last_modified_by == o.last_modified_by &&
|
|
@@ -266,7 +286,7 @@ module DocuSign_WebForms
|
|
|
266
286
|
# Calculates hash code according to all attributes.
|
|
267
287
|
# @return [Fixnum] Hash code
|
|
268
288
|
def hash
|
|
269
|
-
[source, owner, sender, last_modified_by, form_content_modified_by, form_properties_modified_by, last_published_by, last_enabled_by, last_disabled_by, archived_date_time, created_date_time, last_modified_date_time, form_content_modified_date_time, form_properties_modified_date_time, last_published_date_time, last_enabled_date_time, last_disabled_date_time, last_sender_consent_date_time, published_slug, published_component_names].hash
|
|
289
|
+
[source, type, source_form_id, owner, sender, last_modified_by, form_content_modified_by, form_properties_modified_by, last_published_by, last_enabled_by, last_disabled_by, archived_date_time, created_date_time, last_modified_date_time, form_content_modified_date_time, form_properties_modified_date_time, last_published_date_time, last_enabled_date_time, last_disabled_date_time, last_sender_consent_date_time, published_slug, published_component_names].hash
|
|
270
290
|
end
|
|
271
291
|
|
|
272
292
|
# Builds the object from hash
|
|
@@ -24,6 +24,9 @@ module DocuSign_WebForms
|
|
|
24
24
|
# Is the form currently enabled and available for data collection
|
|
25
25
|
attr_accessor :is_enabled
|
|
26
26
|
|
|
27
|
+
# Has the form created through upload
|
|
28
|
+
attr_accessor :is_uploaded
|
|
29
|
+
|
|
27
30
|
# Does the form have draft changes that need to be published?
|
|
28
31
|
attr_accessor :has_draft_changes
|
|
29
32
|
|
|
@@ -40,6 +43,7 @@ module DocuSign_WebForms
|
|
|
40
43
|
:'account_id' => :'accountId',
|
|
41
44
|
:'is_published' => :'isPublished',
|
|
42
45
|
:'is_enabled' => :'isEnabled',
|
|
46
|
+
:'is_uploaded' => :'isUploaded',
|
|
43
47
|
:'has_draft_changes' => :'hasDraftChanges',
|
|
44
48
|
:'form_state' => :'formState',
|
|
45
49
|
:'form_properties' => :'formProperties',
|
|
@@ -54,6 +58,7 @@ module DocuSign_WebForms
|
|
|
54
58
|
:'account_id' => :'String',
|
|
55
59
|
:'is_published' => :'BOOLEAN',
|
|
56
60
|
:'is_enabled' => :'BOOLEAN',
|
|
61
|
+
:'is_uploaded' => :'BOOLEAN',
|
|
57
62
|
:'has_draft_changes' => :'BOOLEAN',
|
|
58
63
|
:'form_state' => :'WebFormState',
|
|
59
64
|
:'form_properties' => :'WebFormProperties',
|
|
@@ -85,6 +90,10 @@ module DocuSign_WebForms
|
|
|
85
90
|
self.is_enabled = attributes[:'isEnabled']
|
|
86
91
|
end
|
|
87
92
|
|
|
93
|
+
if attributes.has_key?(:'isUploaded')
|
|
94
|
+
self.is_uploaded = attributes[:'isUploaded']
|
|
95
|
+
end
|
|
96
|
+
|
|
88
97
|
if attributes.has_key?(:'hasDraftChanges')
|
|
89
98
|
self.has_draft_changes = attributes[:'hasDraftChanges']
|
|
90
99
|
end
|
|
@@ -124,6 +133,7 @@ module DocuSign_WebForms
|
|
|
124
133
|
account_id == o.account_id &&
|
|
125
134
|
is_published == o.is_published &&
|
|
126
135
|
is_enabled == o.is_enabled &&
|
|
136
|
+
is_uploaded == o.is_uploaded &&
|
|
127
137
|
has_draft_changes == o.has_draft_changes &&
|
|
128
138
|
form_state == o.form_state &&
|
|
129
139
|
form_properties == o.form_properties &&
|
|
@@ -139,7 +149,7 @@ module DocuSign_WebForms
|
|
|
139
149
|
# Calculates hash code according to all attributes.
|
|
140
150
|
# @return [Fixnum] Hash code
|
|
141
151
|
def hash
|
|
142
|
-
[id, account_id, is_published, is_enabled, has_draft_changes, form_state, form_properties, form_metadata].hash
|
|
152
|
+
[id, account_id, is_published, is_enabled, is_uploaded, has_draft_changes, form_state, form_properties, form_metadata].hash
|
|
143
153
|
end
|
|
144
154
|
|
|
145
155
|
# Builds the object from hash
|