README.md in docusign_webforms-1.0.2.rc12 vs README.md in docusign_webforms-2.0.0.rc1
- old
+ new
@@ -1,131 +1,95 @@
-# docusign_webforms
+# The Official Docusign WebForms Ruby Client SDK
-DocuSign_WebForms - the Ruby gem for the Web Forms API version 1.1
+The Docusign SDK makes integrating Docusign into your apps and websites a seamless experience.
-The Web Forms API facilitates generating semantic HTML forms around everyday contracts.
+## Table of Contents
+- [Introduction](#introduction)
+- [Installation](#installation)
+ * [Version Information](#versionInformation)
+ * [Requirements](#requirements)
+ * [Compatibility](#compatibility)
+ * [Installation via your application's Gemfile](#installationViaGem)
+ * [Manual Installation](#manualInstallation)
+- [Dependencies](#dependencies)
+- [API Reference](#apiReference)
+- [Code Examples](#codeExamples)
+- [OAuth Implementations](#oauthImplementations)
+- [Changelog](#changeLog)
+- [Support](#support)
+- [License](#license)
+- [Additional Resources](#additionalResources)
-This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
+<a id="introduction"></a>
+## Introduction
+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.
-- API version: 1.1.0
-- Package version: 1.0.2.rc12
-- Build package: io.swagger.codegen.languages.RubyClientCodegen
-For more information, please visit [https://developers.docusign.com/](https://developers.docusign.com/)
-
+<a id="installation"></a>
## Installation
+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.
-### Build a gem
+<a id="versionInformation"></a>
+### Version Information
+- **API version**: 1.1.0
+- **Latest SDK version**: 2.0.0.rc1
-To build the Ruby code into a gem:
+<a id="requirements"></a>
+## Requirements
+* Ruby 1.9+
+* Free [developer account](https://go.docusign.com/o/sandbox/?postActivateUrl=https://developers.docusign.com/)
-```shell
-gem build docusign_webforms.gemspec
-```
+<a id="compatibility"></a>
+## Compatibility
+* Ruby 1.9+
-Then either install the gem locally:
+<a id="installationViaGem"></a>
+### Installation via your application's Gemfile:
+1. In your application's Gemfile, add:
+ `gem 'docusign_webforms'`
+2. Open your preferred console.
+3. In your project directory, execute the installer by typing: **bundle install**
-```shell
-gem install ./docusign_webforms-1.0.2.rc12.gem
-```
-(for development, run `gem install --dev ./docusign_webforms-1.0.2.rc12.gem` to install the development dependencies)
+<a id="manualInstallation"></a>
+### Manual Installation:
+1. Open your preferred console.
+2. In the console, type: **gem install docusign_webforms**
-or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
+<a id="dependencies"></a>
+### SDK Dependencies
+This client has the following external dependencies:
+* Jwt v2.2.1
+* Json v2.1.0
+* addressable v2.7.0
+* Typhoeus v1.0.1
-Finally add this to the Gemfile:
+<a id="apiReference"></a>
+## API Reference
+You can refer to the API reference [here](https://developers.docusign.com/docs/web-forms-api/reference/).
- gem 'docusign_webforms', '~> 1.0.2.rc12'
+<a id="codeExamples"></a>
+## Code examples
+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.
-### Install from Git
+<a id="oauthImplementations"></a>
+## OAuth implementations
+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/).
-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:
+For security purposes, Docusign recommends using the [Authorization Code Grant](https://developers.docusign.com/platform/auth/authcode/) flow.
- gem 'docusign_webforms', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
+<a id="changeLog"></a>
+## Changelog
+You can refer to the complete changelog [here](https://github.com/docusign/docusign-webforms-ruby-client/blob/master/CHANGELOG.md).
-### Include the Ruby code directly
+<a id="support"></a>
+## Support
+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).
-Include the Ruby code directly using `-I` as follows:
+<a id="license"></a>
+## License
+The Docusign WebForms Ruby Client SDK is licensed under the [MIT License](https://github.com/docusign/docusign-webforms-ruby-client/blob/master/LICENSE).
-```shell
-ruby -Ilib script.rb
-```
-
-## Getting Started
-
-Please follow the [installation](#installation) procedure and then run the following code:
-```ruby
-# Load the gem
-require 'docusign_webforms'
-
-# Setup authorization
-DocuSign_WebForms.configure do |config|
- # Configure OAuth2 access token for authorization: docusignAccessCode
- config.access_token = 'YOUR ACCESS TOKEN'
-end
-
-api_instance = DocuSign_WebForms::FormInstanceManagementApi.new
-
-account_id = 'account_id_example' # String | Account identifier in which the web form resides
-
-form_id = 'form_id_example' # String | Unique identifier for a web form entity that is consistent for it's lifetime
-
-create_instance_body = DocuSign_WebForms::CreateInstanceRequestBody.new # CreateInstanceRequestBody | Request body containing properties that will be used to create instance.
-
-
-begin
- #Creates an instance of the web form
- result = api_instance.create_instance(account_id, form_id, create_instance_body)
- p result
-rescue DocuSign_WebForms::ApiError => e
- puts "Exception when calling FormInstanceManagementApi->create_instance: #{e}"
-end
-
-```
-
-## Documentation for API Endpoints
-
-All URIs are relative to *https://www.docusign.net/webforms/v1.1*
-
-Class | Method | HTTP request | Description
------------- | ------------- | ------------- | -------------
-*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
-*DocuSign_WebForms::FormInstanceManagementApi* | [**get_instance**](docs/FormInstanceManagementApi.md#get_instance) | **GET** /accounts/{account_id}/forms/{form_id}/instances/{instance_id} | Get form instance
-*DocuSign_WebForms::FormInstanceManagementApi* | [**list_instances**](docs/FormInstanceManagementApi.md#list_instances) | **GET** /accounts/{account_id}/forms/{form_id}/instances | List instances
-*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
-*DocuSign_WebForms::FormManagementApi* | [**get_form**](docs/FormManagementApi.md#get_form) | **GET** /accounts/{account_id}/forms/{form_id} | Get Form
-*DocuSign_WebForms::FormManagementApi* | [**list_forms**](docs/FormManagementApi.md#list_forms) | **GET** /accounts/{account_id}/forms | List Forms
-
-
-## Documentation for Models
-
- - [DocuSign_WebForms::CreateInstanceRequestBody](docs/CreateInstanceRequestBody.md)
- - [DocuSign_WebForms::HttpError](docs/HttpError.md)
- - [DocuSign_WebForms::HttpSuccess](docs/HttpSuccess.md)
- - [DocuSign_WebForms::InstanceSource](docs/InstanceSource.md)
- - [DocuSign_WebForms::InstanceStatus](docs/InstanceStatus.md)
- - [DocuSign_WebForms::TemplateProperties](docs/TemplateProperties.md)
- - [DocuSign_WebForms::WebForm](docs/WebForm.md)
- - [DocuSign_WebForms::WebFormComponentType](docs/WebFormComponentType.md)
- - [DocuSign_WebForms::WebFormContent](docs/WebFormContent.md)
- - [DocuSign_WebForms::WebFormInstance](docs/WebFormInstance.md)
- - [DocuSign_WebForms::WebFormInstanceEnvelopes](docs/WebFormInstanceEnvelopes.md)
- - [DocuSign_WebForms::WebFormInstanceList](docs/WebFormInstanceList.md)
- - [DocuSign_WebForms::WebFormInstanceMetadata](docs/WebFormInstanceMetadata.md)
- - [DocuSign_WebForms::WebFormMetadata](docs/WebFormMetadata.md)
- - [DocuSign_WebForms::WebFormProperties](docs/WebFormProperties.md)
- - [DocuSign_WebForms::WebFormSource](docs/WebFormSource.md)
- - [DocuSign_WebForms::WebFormState](docs/WebFormState.md)
- - [DocuSign_WebForms::WebFormSummary](docs/WebFormSummary.md)
- - [DocuSign_WebForms::WebFormSummaryList](docs/WebFormSummaryList.md)
- - [DocuSign_WebForms::WebFormUserInfo](docs/WebFormUserInfo.md)
- - [DocuSign_WebForms::WebFormValues](docs/WebFormValues.md)
-
-
-## Documentation for Authorization
-
-
-### docusignAccessCode
-
-- **Type**: OAuth
-- **Flow**: accessCode
-- **Authorization URL**: https://account.docusign.com/oauth/auth
-- **Scopes**: N/A
-
+<a id="additionalResources"></a>
+### Additional resources
+* [Docusign Developer Center](https://developers.docusign.com/)
+* [Docusign API on Twitter](https://twitter.com/docusignapi)
+* [Docusign For Developers on LinkedIn](https://www.linkedin.com/showcase/docusign-for-developers/)
+* [Docusign For Developers on YouTube](https://www.youtube.com/channel/UCJSJ2kMs_qeQotmw4-lX2NQ)
\ No newline at end of file