-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1 from docusign/1.0.2.rc12-v1.1.0-1.0.2
Version 1.0.2.rc12 release
- Loading branch information
Showing
81 changed files
with
13,241 additions
and
22 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
--color | ||
--require spec_helper |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,148 @@ | ||
# This file is based on https://github.com/rails/rails/blob/master/.rubocop.yml (MIT license) | ||
# Automatically generated by Swagger Codegen (https://github.com/swagger-api/swagger-codegen) | ||
AllCops: | ||
TargetRubyVersion: 2.6 | ||
# RuboCop has a bunch of cops enabled by default. This setting tells RuboCop | ||
# to ignore them, so only the ones explicitly set in this file are enabled. | ||
DisabledByDefault: true | ||
Exclude: | ||
- '**/templates/**/*' | ||
- '**/vendor/**/*' | ||
- 'actionpack/lib/action_dispatch/journey/parser.rb' | ||
|
||
# Prefer &&/|| over and/or. | ||
Style/AndOr: | ||
Enabled: true | ||
|
||
# Align `when` with `case`. | ||
Layout/CaseIndentation: | ||
Enabled: true | ||
|
||
# Align comments with method definitions. | ||
Layout/CommentIndentation: | ||
Enabled: true | ||
|
||
Layout/ElseAlignment: | ||
Enabled: true | ||
|
||
Layout/EmptyLineAfterMagicComment: | ||
Enabled: true | ||
|
||
# In a regular class definition, no empty lines around the body. | ||
Layout/EmptyLinesAroundClassBody: | ||
Enabled: true | ||
|
||
# In a regular method definition, no empty lines around the body. | ||
Layout/EmptyLinesAroundMethodBody: | ||
Enabled: true | ||
|
||
# In a regular module definition, no empty lines around the body. | ||
Layout/EmptyLinesAroundModuleBody: | ||
Enabled: true | ||
|
||
Layout/FirstParameterIndentation: | ||
Enabled: true | ||
|
||
# Use Ruby >= 1.9 syntax for hashes. Prefer { a: :b } over { :a => :b }. | ||
Style/HashSyntax: | ||
Enabled: false | ||
|
||
# Method definitions after `private` or `protected` isolated calls need one | ||
# extra level of indentation. | ||
Layout/IndentationConsistency: | ||
Enabled: true | ||
EnforcedStyle: indented_internal_methods | ||
|
||
# Two spaces, no tabs (for indentation). | ||
Layout/IndentationWidth: | ||
Enabled: true | ||
|
||
Layout/LeadingCommentSpace: | ||
Enabled: true | ||
|
||
Layout/SpaceAfterColon: | ||
Enabled: true | ||
|
||
Layout/SpaceAfterComma: | ||
Enabled: true | ||
|
||
Layout/SpaceAroundEqualsInParameterDefault: | ||
Enabled: true | ||
|
||
Layout/SpaceAroundKeyword: | ||
Enabled: true | ||
|
||
Layout/SpaceAroundOperators: | ||
Enabled: true | ||
|
||
Layout/SpaceBeforeComma: | ||
Enabled: true | ||
|
||
Layout/SpaceBeforeFirstArg: | ||
Enabled: true | ||
|
||
Style/DefWithParentheses: | ||
Enabled: true | ||
|
||
# Defining a method with parameters needs parentheses. | ||
Style/MethodDefParentheses: | ||
Enabled: true | ||
|
||
Style/FrozenStringLiteralComment: | ||
Enabled: false | ||
EnforcedStyle: always | ||
|
||
# Use `foo {}` not `foo{}`. | ||
Layout/SpaceBeforeBlockBraces: | ||
Enabled: true | ||
|
||
# Use `foo { bar }` not `foo {bar}`. | ||
Layout/SpaceInsideBlockBraces: | ||
Enabled: true | ||
|
||
# Use `{ a: 1 }` not `{a:1}`. | ||
Layout/SpaceInsideHashLiteralBraces: | ||
Enabled: true | ||
|
||
Layout/SpaceInsideParens: | ||
Enabled: true | ||
|
||
# Check quotes usage according to lint rule below. | ||
#Style/StringLiterals: | ||
# Enabled: true | ||
# EnforcedStyle: single_quotes | ||
|
||
# Detect hard tabs, no hard tabs. | ||
Layout/IndentationStyle: | ||
Enabled: true | ||
|
||
# Blank lines should not have any spaces. | ||
Layout/TrailingEmptyLines: | ||
Enabled: true | ||
|
||
# No trailing whitespace. | ||
Layout/TrailingWhitespace: | ||
Enabled: false | ||
|
||
# Use quotes for string literals when they are enough. | ||
Style/RedundantPercentQ: | ||
Enabled: true | ||
|
||
# Align `end` with the matching keyword or starting expression except for | ||
# assignments, where it should be aligned with the LHS. | ||
Lint/EndAlignment: | ||
Enabled: true | ||
EnforcedStyleAlignWith: variable | ||
AutoCorrect: true | ||
|
||
# Use my_method(my_arg) not my_method( my_arg ) or my_method my_arg. | ||
Lint/RequireParentheses: | ||
Enabled: true | ||
|
||
Style/RedundantReturn: | ||
Enabled: true | ||
AllowMultipleReturnValues: true | ||
|
||
Style/Semicolon: | ||
Enabled: true | ||
AllowAsExpressionSeparator: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
# Swagger Codegen Ignore | ||
# Generated by swagger-codegen https://github.com/swagger-api/swagger-codegen | ||
|
||
# Use this file to prevent files from being overwritten by the generator. | ||
# The patterns follow closely to .gitignore or .dockerignore. | ||
|
||
# As an example, the C# client generator defines ApiClient.cs. | ||
# You can make changes and tell Swagger Codgen to ignore just this file by uncommenting the following line: | ||
#ApiClient.cs | ||
|
||
# You can match any string of characters against a directory, file or extension with a single asterisk (*): | ||
#foo/*/qux | ||
# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux | ||
|
||
# You can recursively match patterns against a directory, file or extension with a double asterisk (**): | ||
#foo/**/qux | ||
# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux | ||
|
||
# You can also negate patterns with an exclamation (!). | ||
# For example, you can ignore all files in a docs folder with the file extension .md: | ||
#docs/*.md | ||
# Then explicitly reverse the ignore rule for a single file: | ||
#!docs/README.md | ||
|
||
|
||
# Swagger and Git files | ||
.swagger-codegen-ignore | ||
git_push.sh | ||
.gitignore | ||
CHANGELOG.md | ||
|
||
|
||
# Project files | ||
LICENSE | ||
.travis.yml | ||
Gemfile | ||
Gemfile.lock | ||
Rakefile | ||
|
||
# Specific src and test files | ||
.rspec | ||
docs/ | ||
spec/ | ||
tests/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
2.4.21 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
## [v1.0.2.rc12] - WebForms API v1.1.0-1.0.2 - 2024-02-09 | ||
### Breaking Changes | ||
|
||
- **`baseUrl` Defaulting to DEMO URL:** | ||
- The `baseUrl` now defaults to the DEMO URL if not provided. Please update your configurations accordingly. | ||
|
||
### Other Changes | ||
|
||
- Updated the SDK release version | ||
## [v1.0.2.rc11] - WebForms API v1.1.0-1.0.2 - 2024-02-08 | ||
### Changed | ||
- Added support for version v1.1.0-1.0.2 of the DocuSign WebForms API. | ||
- Updated the SDK release version. | ||
|
||
## [v1.0.1.rc9] - WebForms API v1.1.0-1.0.1 - 2024-02-05 | ||
### Changed | ||
- Added support for version v1.1.0-1.0.1 of the DocuSign WebForms API. | ||
- Updated the SDK release version. | ||
|
||
## [v1.0.0.rc05] - WebForms API v1.1.0-1.0.0 - 2023-12-26 | ||
### Changed | ||
- Added support for version v1.1.0-1.0.0 of the DocuSign WebForms API. | ||
- Updated the SDK release version. | ||
|
||
## [v1.0.0.rc04] - WebForms API v1.1.0-1.0.0 - 2023-12-18 | ||
### Changed | ||
- Added support for version v1.1.0-1.0.0 of the DocuSign WebForms API. | ||
- Updated the SDK release version. | ||
|
||
## [v1.0.0.rc02] - WebForms API 1.1.0-1.0.0 - 2023-12-14 | ||
### Changed | ||
- Added support for version 1.1.0-1.0.0 of the DocuSign WebForms API. | ||
- Updated the SDK release version. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
source 'https://rubygems.org' | ||
|
||
gemspec | ||
|
||
group :development, :test do | ||
gem 'rake', '~> 12.3.3' | ||
end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,131 @@ | ||
# docusign-webforms-ruby-client | ||
# 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.2.rc12 | ||
- 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.2.rc12.gem | ||
``` | ||
(for development, run `gem install --dev ./docusign_webforms-1.0.2.rc12.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.2.rc12' | ||
|
||
### 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::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 | ||
|
Oops, something went wrong.