Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 41 additions & 0 deletions .swagger-codegen-ignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# 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
.gitignore
git_push.sh
CHANGELOG.md

# Specific src and test files
tox.ini
docs/
test/

# Project Files

# [DCM-11154]: [SDK] [WebForms API] [Python] Issue with web_form.py
# Added this file to mitigate the issue during code generation where bad code is getting generated for Inheritance logic
docusign_webforms/models/web_form.py

1 change: 1 addition & 0 deletions .swagger-codegen/VERSION
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
2.4.21
16 changes: 16 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# ref: https://docs.travis-ci.com/user/languages/python
language: python
python:
- "2.7"
- "3.2"
- "3.3"
- "3.4"
- "3.5"
#- "3.5-dev" # 3.5 development branch
#- "nightly" # points to the latest development branch e.g. 3.6-dev
# command to install dependencies
install:
- pip install -r requirements.txt
- pip install -r test-requirements.txt
# command to run tests
script: nosetests -s
39 changes: 39 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
## [v1.0.2rc12] - 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.2rc11] - 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.1rc9] - 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.0rc6] - WebForms API v1.1.0-1.0.0 - 2024-01-05
### Changed
- Added support for version v1.1.0-1.0.0 of the DocuSign WebForms API.
- Updated the SDK release version.

## [v1.0.0rc05] - 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.0rc04] - 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.0rc03] - WebForms API 1.1.0-1.0.0 - 2023-12-15
### Changed
- Added support for version 1.1.0-1.0.0 of the DocuSign WebForms API.
- Updated the SDK release version.

21 changes: 0 additions & 21 deletions LICENSE

This file was deleted.

129 changes: 127 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,127 @@
# docusign-webforms-python-client
DocuSign Python Web Forms SDK
# 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.2rc12
- 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

- [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

57 changes: 57 additions & 0 deletions docusign_webforms/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
# coding: utf-8

# flake8: noqa

"""
Web Forms API version 1.1

The Web Forms API facilitates generating semantic HTML forms around everyday contracts. # noqa: E501

OpenAPI spec version: 1.1.0
Contact: devcenter@docusign.com
Generated by: https://github.com/swagger-api/swagger-codegen.git
"""


from __future__ import absolute_import

# import apis into sdk package
from .apis.form_instance_management_api import FormInstanceManagementApi
from .apis.form_management_api import FormManagementApi

# import ApiClient
from .client.api_client import ApiClient
from .client.configuration import Configuration
from .client.api_exception import ApiException

from .client.auth.oauth import OAuth
from .client.auth.oauth import OAuthToken
from .client.auth.oauth import Account
from .client.auth.oauth import Organization
from .client.auth.oauth import Link

# import models into sdk package
from docusign_webforms.models.create_instance_request_body import CreateInstanceRequestBody
from docusign_webforms.models.http_error import HttpError
from docusign_webforms.models.http_success import HttpSuccess
from docusign_webforms.models.instance_source import InstanceSource
from docusign_webforms.models.instance_status import InstanceStatus
from docusign_webforms.models.template_properties import TemplateProperties
from docusign_webforms.models.web_form import WebForm
from docusign_webforms.models.web_form_component_type import WebFormComponentType
from docusign_webforms.models.web_form_content import WebFormContent
from docusign_webforms.models.web_form_instance import WebFormInstance
from docusign_webforms.models.web_form_instance_envelopes import WebFormInstanceEnvelopes
from docusign_webforms.models.web_form_instance_list import WebFormInstanceList
from docusign_webforms.models.web_form_instance_metadata import WebFormInstanceMetadata
from docusign_webforms.models.web_form_metadata import WebFormMetadata
from docusign_webforms.models.web_form_properties import WebFormProperties
from docusign_webforms.models.web_form_source import WebFormSource
from docusign_webforms.models.web_form_state import WebFormState
from docusign_webforms.models.web_form_summary import WebFormSummary
from docusign_webforms.models.web_form_summary_list import WebFormSummaryList
from docusign_webforms.models.web_form_user_info import WebFormUserInfo
from docusign_webforms.models.web_form_values import WebFormValues


configuration = Configuration()
7 changes: 7 additions & 0 deletions docusign_webforms/apis/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
from __future__ import absolute_import

# flake8: noqa

# import apis into api package
from .form_instance_management_api import FormInstanceManagementApi
from .form_management_api import FormManagementApi
Loading