# docusign_webforms

DocuSign_WebForms - the Ruby gem for the Web Forms API version 1.1

The Web Forms API facilitates generating semantic HTML forms around everyday contracts. 

This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:

- API version: 1.1.0
- Package version: 1.0.0
- Build package: io.swagger.codegen.languages.RubyClientCodegen
For more information, please visit [https://developers.docusign.com/](https://developers.docusign.com/)

## Installation

### Build a gem

To build the Ruby code into a gem:

```shell
gem build docusign_webforms.gemspec
```

Then either install the gem locally:

```shell
gem install ./docusign_webforms-1.0.0.gem
```
(for development, run `gem install --dev ./docusign_webforms-1.0.0.gem` to install the development dependencies)

or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).

Finally add this to the Gemfile:

    gem 'docusign_webforms', '~> 1.0.0'

### Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:

    gem 'docusign_webforms', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'

### Include the Ruby code directly

Include the Ruby code directly using `-I` as follows:

```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::AuthenticationMethod](docs/AuthenticationMethod.md)
 - [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