# docusign-webforms
The Web Forms API facilitates generating semantic HTML forms around everyday contracts.
This Python package 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.PythonClientCodegen
For more information, please visit [https://developers.docusign.com/](https://developers.docusign.com/)
## Requirements.
Python 2.7 and 3.4+
## Installation & Usage
### pip install
If the python package is hosted on Github, you can install directly from Github
```sh
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)
Then import the package:
```python
import docusign_webforms
```
### Setuptools
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)
Then import the package:
```python
import docusign_webforms
```
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
from __future__ import print_function
import time
import docusign_webforms
from docusign_webforms.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: docusignAccessCode
configuration = docusign_webforms.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'
# create an instance of the API class
api_instance = docusign_webforms.FormInstanceManagementApi(docusign_webforms.ApiClient(configuration))
account_id = 'account_id_example' # str | Account identifier in which the web form resides
form_id = 'form_id_example' # str | Unique identifier for a web form entity that is consistent for it's lifetime
create_instance_body = docusign_webforms.CreateInstanceRequestBody() # CreateInstanceRequestBody | Request body containing properties that will be used to create instance.
try:
# Creates an instance of the web form
api_response = api_instance.create_instance(account_id, form_id, create_instance_body)
pprint(api_response)
except ApiException as e:
print("Exception when calling FormInstanceManagementApi->create_instance: %s\n" % e)
```
## Documentation for API Endpoints
All URIs are relative to *https://www.docusign.net/webforms/v1.1*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*FormInstanceManagementApi* | [**create_instance**](docs/FormInstanceManagementApi.md#create_instance) | **POST** /accounts/{account_id}/forms/{form_id}/instances | Creates an instance of the web form
*FormInstanceManagementApi* | [**get_instance**](docs/FormInstanceManagementApi.md#get_instance) | **GET** /accounts/{account_id}/forms/{form_id}/instances/{instance_id} | Get form instance
*FormInstanceManagementApi* | [**list_instances**](docs/FormInstanceManagementApi.md#list_instances) | **GET** /accounts/{account_id}/forms/{form_id}/instances | List instances
*FormInstanceManagementApi* | [**refresh_token**](docs/FormInstanceManagementApi.md#refresh_token) | **POST** /accounts/{account_id}/forms/{form_id}/instances/{instance_id}/refresh | Refreshes the instance token
*FormManagementApi* | [**get_form**](docs/FormManagementApi.md#get_form) | **GET** /accounts/{account_id}/forms/{form_id} | Get Form
*FormManagementApi* | [**list_forms**](docs/FormManagementApi.md#list_forms) | **GET** /accounts/{account_id}/forms | List Forms
## Documentation For Models
- [AuthenticationMethod](docs/AuthenticationMethod.md)
- [CreateInstanceRequestBody](docs/CreateInstanceRequestBody.md)
- [HttpError](docs/HttpError.md)
- [HttpSuccess](docs/HttpSuccess.md)
- [InstanceSource](docs/InstanceSource.md)
- [InstanceStatus](docs/InstanceStatus.md)
- [TemplateProperties](docs/TemplateProperties.md)
- [WebForm](docs/WebForm.md)
- [WebFormComponentType](docs/WebFormComponentType.md)
- [WebFormContent](docs/WebFormContent.md)
- [WebFormInstance](docs/WebFormInstance.md)
- [WebFormInstanceEnvelopes](docs/WebFormInstanceEnvelopes.md)
- [WebFormInstanceList](docs/WebFormInstanceList.md)
- [WebFormInstanceMetadata](docs/WebFormInstanceMetadata.md)
- [WebFormMetadata](docs/WebFormMetadata.md)
- [WebFormProperties](docs/WebFormProperties.md)
- [WebFormSource](docs/WebFormSource.md)
- [WebFormState](docs/WebFormState.md)
- [WebFormSummary](docs/WebFormSummary.md)
- [WebFormSummaryList](docs/WebFormSummaryList.md)
- [WebFormUserInfo](docs/WebFormUserInfo.md)
- [WebFormValues](docs/WebFormValues.md)
## Documentation For Authorization
## docusignAccessCode
- **Type**: OAuth
- **Flow**: accessCode
- **Authorization URL**: https://account.docusign.com/oauth/auth
- **Scopes**: N/A
## Author
devcenter@docusign.com
Raw data
{
"_id": null,
"home_page": "",
"name": "docusign-webforms",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "Swagger,Web Forms API version 1.1",
"author": "",
"author_email": "devcenter@docusign.com",
"download_url": "https://files.pythonhosted.org/packages/2c/42/f09f428a0a0f4b1e0388259d1f35c2600752e1802e23ac45e41ae466b08f/docusign-webforms-1.0.0.tar.gz",
"platform": null,
"description": "# docusign-webforms\nThe Web Forms API facilitates generating semantic HTML forms around everyday contracts. \n\nThis Python package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:\n\n- API version: 1.1.0\n- Package version: 1.0.0\n- Build package: io.swagger.codegen.languages.PythonClientCodegen\nFor more information, please visit [https://developers.docusign.com/](https://developers.docusign.com/)\n\n## Requirements.\n\nPython 2.7 and 3.4+\n\n## Installation & Usage\n### pip install\n\nIf the python package is hosted on Github, you can install directly from Github\n\n```sh\npip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git\n```\n(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)\n\nThen import the package:\n```python\nimport docusign_webforms \n```\n\n### Setuptools\n\nInstall via [Setuptools](http://pypi.python.org/pypi/setuptools).\n\n```sh\npython setup.py install --user\n```\n(or `sudo python setup.py install` to install the package for all users)\n\nThen import the package:\n```python\nimport docusign_webforms\n```\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```python\nfrom __future__ import print_function\nimport time\nimport docusign_webforms\nfrom docusign_webforms.rest import ApiException\nfrom pprint import pprint\n\n# Configure OAuth2 access token for authorization: docusignAccessCode\nconfiguration = docusign_webforms.Configuration()\nconfiguration.access_token = 'YOUR_ACCESS_TOKEN'\n\n# create an instance of the API class\napi_instance = docusign_webforms.FormInstanceManagementApi(docusign_webforms.ApiClient(configuration))\naccount_id = 'account_id_example' # str | Account identifier in which the web form resides\nform_id = 'form_id_example' # str | Unique identifier for a web form entity that is consistent for it's lifetime\ncreate_instance_body = docusign_webforms.CreateInstanceRequestBody() # CreateInstanceRequestBody | Request body containing properties that will be used to create instance.\n\ntry:\n # Creates an instance of the web form\n api_response = api_instance.create_instance(account_id, form_id, create_instance_body)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling FormInstanceManagementApi->create_instance: %s\\n\" % e)\n\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *https://www.docusign.net/webforms/v1.1*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*FormInstanceManagementApi* | [**create_instance**](docs/FormInstanceManagementApi.md#create_instance) | **POST** /accounts/{account_id}/forms/{form_id}/instances | Creates an instance of the web form\n*FormInstanceManagementApi* | [**get_instance**](docs/FormInstanceManagementApi.md#get_instance) | **GET** /accounts/{account_id}/forms/{form_id}/instances/{instance_id} | Get form instance\n*FormInstanceManagementApi* | [**list_instances**](docs/FormInstanceManagementApi.md#list_instances) | **GET** /accounts/{account_id}/forms/{form_id}/instances | List instances\n*FormInstanceManagementApi* | [**refresh_token**](docs/FormInstanceManagementApi.md#refresh_token) | **POST** /accounts/{account_id}/forms/{form_id}/instances/{instance_id}/refresh | Refreshes the instance token\n*FormManagementApi* | [**get_form**](docs/FormManagementApi.md#get_form) | **GET** /accounts/{account_id}/forms/{form_id} | Get Form\n*FormManagementApi* | [**list_forms**](docs/FormManagementApi.md#list_forms) | **GET** /accounts/{account_id}/forms | List Forms\n\n\n## Documentation For Models\n\n - [AuthenticationMethod](docs/AuthenticationMethod.md)\n - [CreateInstanceRequestBody](docs/CreateInstanceRequestBody.md)\n - [HttpError](docs/HttpError.md)\n - [HttpSuccess](docs/HttpSuccess.md)\n - [InstanceSource](docs/InstanceSource.md)\n - [InstanceStatus](docs/InstanceStatus.md)\n - [TemplateProperties](docs/TemplateProperties.md)\n - [WebForm](docs/WebForm.md)\n - [WebFormComponentType](docs/WebFormComponentType.md)\n - [WebFormContent](docs/WebFormContent.md)\n - [WebFormInstance](docs/WebFormInstance.md)\n - [WebFormInstanceEnvelopes](docs/WebFormInstanceEnvelopes.md)\n - [WebFormInstanceList](docs/WebFormInstanceList.md)\n - [WebFormInstanceMetadata](docs/WebFormInstanceMetadata.md)\n - [WebFormMetadata](docs/WebFormMetadata.md)\n - [WebFormProperties](docs/WebFormProperties.md)\n - [WebFormSource](docs/WebFormSource.md)\n - [WebFormState](docs/WebFormState.md)\n - [WebFormSummary](docs/WebFormSummary.md)\n - [WebFormSummaryList](docs/WebFormSummaryList.md)\n - [WebFormUserInfo](docs/WebFormUserInfo.md)\n - [WebFormValues](docs/WebFormValues.md)\n\n\n## Documentation For Authorization\n\n\n## docusignAccessCode\n\n- **Type**: OAuth\n- **Flow**: accessCode\n- **Authorization URL**: https://account.docusign.com/oauth/auth\n- **Scopes**: N/A\n\n\n## Author\n\ndevcenter@docusign.com\n\n",
"bugtrack_url": null,
"license": "",
"summary": "Web Forms API version 1.1",
"version": "1.0.0",
"project_urls": null,
"split_keywords": [
"swagger",
"web forms api version 1.1"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "aec8669da56ef5cdf91f7b14598f99fd2d1039d4083ad747c3e6dd0c58578e0b",
"md5": "d6c69fa3d3c782bf7b6173cb9789ba04",
"sha256": "0b7ac0874e1784cfa12c953ca80546d54fab7cef36d8e359b9efb57863de8f3a"
},
"downloads": -1,
"filename": "docusign_webforms-1.0.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "d6c69fa3d3c782bf7b6173cb9789ba04",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 109823,
"upload_time": "2024-02-14T12:37:55",
"upload_time_iso_8601": "2024-02-14T12:37:55.466602Z",
"url": "https://files.pythonhosted.org/packages/ae/c8/669da56ef5cdf91f7b14598f99fd2d1039d4083ad747c3e6dd0c58578e0b/docusign_webforms-1.0.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2c42f09f428a0a0f4b1e0388259d1f35c2600752e1802e23ac45e41ae466b08f",
"md5": "b0497de0b325f2938c81272e9857bfe6",
"sha256": "94c315533297dcd9b2df20e6004ebca4fefdeebc9077922dd6567632f5640edc"
},
"downloads": -1,
"filename": "docusign-webforms-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "b0497de0b325f2938c81272e9857bfe6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 37754,
"upload_time": "2024-02-14T12:37:56",
"upload_time_iso_8601": "2024-02-14T12:37:56.668853Z",
"url": "https://files.pythonhosted.org/packages/2c/42/f09f428a0a0f4b1e0388259d1f35c2600752e1802e23ac45e41ae466b08f/docusign-webforms-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-14 12:37:56",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "docusign-webforms"
}
JSON