├── test ├── __init__.py ├── keys │ └── private.pem ├── unit_tests.py └── test_oauth.py ├── .swagger-codegen └── VERSION ├── setup.cfg ├── .gitattributes ├── test-requirements.txt ├── linter.sh ├── docusign_click ├── apis │ └── __init__.py ├── client │ ├── auth │ │ └── __init__.py │ ├── __init__.py │ ├── api_exception.py │ └── configuration.py ├── models │ ├── __init__.py │ ├── document_conversion_request.py │ ├── document_conversion_response.py │ ├── html_result.py │ ├── clickwraps_delete_response.py │ ├── disclosure_link_styles.py │ ├── error_details.py │ ├── service_version.py │ ├── conversion_document.py │ ├── data_field.py │ ├── clickwrap_transfer_request.py │ ├── bulk_clickwrap_request.py │ ├── clickwraps_response.py │ ├── clickwrap_versions_delete_response.py │ ├── clickwrap_scheduled_reacceptance.py │ ├── clickwrap_versions_response.py │ ├── user_agreement_request.py │ ├── container_styles.py │ ├── document_data.py │ ├── clickwrap_agreements_response.py │ ├── clickwrap_delete_response.py │ ├── agreement_statement_styles.py │ ├── service_information.py │ ├── header_styles.py │ ├── clickwrap_versions_paged_response.py │ └── document.py └── __init__.py ├── requirements.txt ├── tox.ini ├── .travis.yml ├── .gitignore ├── LICENSE ├── .swagger-codegen-ignore ├── CHANGELOG.md ├── setup.py └── README.md /test/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /.swagger-codegen/VERSION: -------------------------------------------------------------------------------- 1 | 2.4.21-SNAPSHOT -------------------------------------------------------------------------------- /setup.cfg: -------------------------------------------------------------------------------- 1 | [metadata] 2 | description-file = README.md 3 | -------------------------------------------------------------------------------- /.gitattributes: -------------------------------------------------------------------------------- 1 | # Auto detect text files and perform LF normalization 2 | * text=auto 3 | -------------------------------------------------------------------------------- /test-requirements.txt: -------------------------------------------------------------------------------- 1 | coverage>=4.0.3 2 | nose>=1.3.7 3 | pluggy>=0.3.1 4 | py>=1.4.31 5 | randomize>=0.13 6 | tox 7 | -------------------------------------------------------------------------------- /linter.sh: -------------------------------------------------------------------------------- 1 | autopep8 --in-place --aggressive --recursive docusign_esign && pycodestyle --ignore=E501,W504,W503 -v docusign_esign -------------------------------------------------------------------------------- /docusign_click/apis/__init__.py: -------------------------------------------------------------------------------- 1 | from __future__ import absolute_import 2 | 3 | # flake8: noqa 4 | 5 | # import apis into api package 6 | from .accounts_api import AccountsApi 7 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | certifi >= 14.05.14 2 | six >= 1.8.0 3 | python_dateutil >= 2.5.3 4 | setuptools >= 21.0.0 5 | urllib3 >= 1.15 6 | PyJWT>=1.7.1 7 | cryptography>=2.5 8 | nose>=1.3.7 9 | -------------------------------------------------------------------------------- /tox.ini: -------------------------------------------------------------------------------- 1 | [tox] 2 | envlist = py27, py3 3 | 4 | [testenv] 5 | deps=-r{toxinidir}/requirements.txt 6 | -r{toxinidir}/test-requirements.txt 7 | 8 | commands= 9 | nosetests -s \ 10 | [] -------------------------------------------------------------------------------- /docusign_click/client/auth/__init__.py: -------------------------------------------------------------------------------- 1 | from __future__ import absolute_import 2 | 3 | # import auth modules into client package 4 | from .oauth import Account 5 | from .oauth import Organization 6 | from .oauth import Link 7 | from .oauth import OAuth 8 | from .oauth import OAuthToken -------------------------------------------------------------------------------- /docusign_click/client/__init__.py: -------------------------------------------------------------------------------- 1 | from __future__ import absolute_import 2 | 3 | # import auth modules into client package 4 | from .auth.oauth import Account 5 | from .auth.oauth import Organization 6 | from .auth.oauth import Link 7 | from .auth.oauth import OAuth 8 | from .auth.oauth import OAuthToken 9 | from .auth.oauth import OAuthUserInfo 10 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | branches: 2 | only: 3 | - master 4 | language: python 5 | python: 6 | - "2.7" 7 | - "3.7" 8 | - "nightly" # points to the latest development branch e.g. 3.7-dev 9 | # command to install dependencies 10 | install: 11 | - pip install -r requirements.txt 12 | - pip install -r test-requirements.txt 13 | # command to run tests 14 | script: nosetests -s 15 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | env/ 12 | build/ 13 | develop-eggs/ 14 | dist/ 15 | downloads/ 16 | eggs/ 17 | .eggs/ 18 | lib/ 19 | lib64/ 20 | parts/ 21 | sdist/ 22 | var/ 23 | *.egg-info/ 24 | .installed.cfg 25 | *.egg 26 | 27 | # PyInstaller 28 | # Usually these files are written by a python script from a template 29 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 30 | *.manifest 31 | *.spec 32 | 33 | # Installer logs 34 | pip-log.txt 35 | pip-delete-this-directory.txt 36 | 37 | # Unit test / coverage reports 38 | htmlcov/ 39 | .tox/ 40 | .coverage 41 | .coverage.* 42 | .cache 43 | nosetests.xml 44 | coverage.xml 45 | *,cover 46 | .hypothesis/ 47 | venv/ 48 | .python-version 49 | 50 | # Translations 51 | *.mo 52 | *.pot 53 | 54 | # Django stuff: 55 | *.log 56 | 57 | # Sphinx documentation 58 | docs/_build/ 59 | 60 | # PyBuilder 61 | target/ 62 | 63 | #Ipython Notebook 64 | .ipynb_checkpoints 65 | 66 | #Idea IDEs 67 | .idea 68 | 69 | # Local files 70 | *.DS_Store 71 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | The MIT License 2 | 3 | Copyright (c) 2020- DocuSign, Inc. (https://www.docusign.com) 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. -------------------------------------------------------------------------------- /.swagger-codegen-ignore: -------------------------------------------------------------------------------- 1 | # Swagger Codegen Ignore 2 | 3 | # Use this file to prevent files from being overwritten by the generator. 4 | # The patterns follow closely to .gitignore or .dockerignore. 5 | 6 | # As an example, the C# client generator defines ApiClient.cs. 7 | # You can make changes and tell Swagger Codgen to ignore just this file by uncommenting the following line: 8 | #ApiClient.cs 9 | 10 | # You can match any string of characters against a directory, file or extension with a single asterisk (*): 11 | #foo/*/qux 12 | # The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux 13 | 14 | # You can recursively match patterns against a directory, file or extension with a double asterisk (**): 15 | #foo/**/qux 16 | # This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux 17 | 18 | # You can also negate patterns with an exclamation (!). 19 | # For example, you can ignore all files in a docs folder with the file extension .md: 20 | #docs/*.md 21 | # Then explicitly reverse the ignore rule for a single file: 22 | #!docs/README.md 23 | 24 | # Swagger and Git files 25 | .swagger-codegen-ignore 26 | git_push.sh 27 | .gitignore 28 | README.md 29 | CHANGELOG.md 30 | best_practices.md 31 | 32 | 33 | # Project files 34 | LICENSE 35 | .travis.yml 36 | requirements.txt 37 | test-requirements.txt 38 | setup.cfg 39 | #setup.py 40 | 41 | 42 | # Specific src and test files 43 | tox.ini 44 | docs/ 45 | test/ 46 | docusign_click/client/ 47 | #docusign_rooms/__init__.py 48 | docusign_click/api_client.py 49 | docusign_click/configuration.py 50 | docusign_click/rest.py 51 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # DocuSign Click Python Client Changelog 2 | All notable changes to this project will be documented in this file. 3 | 4 | See [DocuSign Support Center](https://support.docusign.com/en/releasenotes/) for Product Release Notes. 5 | 6 | ## [v1.4.0] - Click API v1-22.4.02.00 - 2023-06-13 7 | ### Changed 8 | - Added support for version v1-22.4.02.00 of the DocuSign Click API. 9 | - Updated the SDK release version. 10 | 11 | ## [v1.3.0] - Click API v1-22.4.01.00 - 2023-02-13 12 | ### Changed 13 | - Added support for version v1-22.4.01.00 of the DocuSign Click API. 14 | - Updated the SDK release version. 15 | 16 | ## [v1.2.2] - Click API v1-22.3.01.00 - 2022-10-28 17 | ### Changed 18 | - Added support for version v1-22.3.01.00 of the DocuSign Click API. 19 | - Updated the SDK release version. 20 | 21 | ## [1.1.0] - Click API v1-21.4.01 - 2021-12-09 22 | ### Changed 23 | - Added support for version v1-21.4.01 of the DocuSign Click API. 24 | - Updated the SDK release version. 25 | 26 | 27 | ## [1.1.0rc1] - Click API v1-21.4.00 - 2021-11-19 28 | ### Changed 29 | - Added support for version v1-21.4.00 of the DocuSign Click API. 30 | - Updated the SDK release version. 31 | 32 | 33 | ## [v1.0.0] - Click API v1-20.4.02 - 2020-02-11 34 | ### Changed 35 | - Updated the Base folder structure to adhere to DocuSign naming convention. 36 | - Updated and limited PyJwt library to not make any breaking changes to the Click SDK. 37 | - Marking parameter in functions such as `get_clickwrap_version..` required which was missing earlier. 38 | 39 | ## [v1.0.0b1] - Click API v1-20.3.02 - 2020-12-17 40 | ### Changed 41 | - First BETA version of Click API -------------------------------------------------------------------------------- /docusign_click/client/api_exception.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | DocuSign REST API 5 | 6 | The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. 7 | 8 | OpenAPI spec version: v2 9 | Contact: devcenter@docusign.com 10 | Generated by: https://github.com/swagger-api/swagger-codegen.git 11 | """ 12 | 13 | from __future__ import absolute_import 14 | 15 | 16 | class ApiException(Exception): 17 | 18 | def __init__(self, status=None, reason=None, http_resp=None): 19 | if http_resp: 20 | self.status = http_resp.status 21 | self.reason = http_resp.reason 22 | self.body = http_resp.data 23 | self.headers = http_resp.getheaders() 24 | else: 25 | self.status = status 26 | self.reason = reason 27 | self.body = None 28 | self.headers = None 29 | 30 | def __str__(self): 31 | """ 32 | Custom error messages for exception 33 | """ 34 | error_message = "({0})\n"\ 35 | "Reason: {1}\n".format(self.status, self.reason) 36 | if self.headers: 37 | error_message += "HTTP response headers: {0}\n".format(self.headers) 38 | 39 | if self.body: 40 | error_message += "HTTP response body: {0}\n".format(self.body) 41 | 42 | return error_message 43 | 44 | 45 | class ArgumentException(Exception): 46 | 47 | def __init__(self, *args, **kwargs): 48 | if not args: 49 | super(Exception).__init__("argument cannot be empty") 50 | else: 51 | super(Exception).__init__(*args, **kwargs) 52 | 53 | 54 | class InvalidBasePath(Exception): 55 | pass 56 | -------------------------------------------------------------------------------- /test/keys/private.pem: -------------------------------------------------------------------------------- 1 | -----BEGIN RSA PRIVATE KEY----- 2 | MIIEogIBAAKCAQEAh0VLAZe6m36tbthAom/IRzxvm/i66mEpow9AsrFP3EAybtVw 3 | 2s13RJ1f0ZJA4sB7SbOtRymIxLlVUWkZLW4NqtECrObqOuke+G2ROWfOhcAyMuiB 4 | lW44mvl8Gil+n6Lwif2+OtUQ88iwPuE6I7jKnBV82lNGDx3H1hqHl7wpQZRyRPCd 5 | zPCrh6TRHj1D40mvrUwqAptj5m71QKA9tWVAQQ1DGKJZVZI4mdz3+I1XCinF8zrx 6 | IUJyEtaJfCHiS086XF3Sw7DkU2o/QIIYbpxlf9Zdjr1QT6/ow7pwJbX2/GSQW2mV 7 | GSY0KSiPFVjbpjKBpVpd4vgnQqn10BzLvLNySwIDAQABAoIBAA2opAm9oeSYlneW 8 | U3RzeBQlWJm1tF39QKCL5jsE52z0eIMzfylAzPW7NFUrgOzEhc5r26fPXFWM5z4I 9 | sDejoLKqVyxRRr57EpsAKUVUI4ji3s7AJnGJxyJy5aKYpQYGhGZSnlY/dG5BSfaX 10 | dHDt9FttWgWLmgvltGt8k0txfvL1nYEQxXxE5gMKNKKoBXE8QF05BmpajApd+hhL 11 | rGLicYpqsrliXr818HvFEKS8ODYfN856osLsvBJDANEW9+OiRQ9QQs5qdStrA5IX 12 | 35DktfSs5Tvr8ZkJksQyfIO4WmEVSJIkm00BL1oSWHAM0Zqv23u6H7HtmCBnvbpw 13 | DY33t+ECgYEA4r9rjODMNhuGgrktDsBE+IQcvoWiYiV00OipZzx0l1q3HmRB51Jo 14 | C/pQ+X6YHT3qZN263VksmlbzpvRQTeL97narhpW8ZdW/L0e6g9sOBchewItftfAJ 15 | CdXmzaaPHEzVu56YGwtS1QC6IVdomxgmXNNuUYgyHt6KgDpVuHBi3usCgYEAmLi/ 16 | cLSnIHPT42WFf2IgQWxT7vcBxe4pL0zjzC4NSi8m//g/F/MpQfgsSjreEx5hE6+4 17 | tAh6J2MZwcejbdCgV6eES84fEGDDYGT3GV9qwCTp6Z374hjP+0ZeGcFnzZLsrPPc 18 | T5K/uaIH7n2dPzNe3aLCslnpStVIUz60mnusoiECgYAUk2A0EXYWdtr248zV6NaZ 19 | YoulMkUw+Msn5eTxbEf8MAwr4tckIZM1ewp8CWPOS38IliJN0bi9bKSBguwClVWL 20 | nRMljFLjPskxhiXDr04PckY+3KbbwKNhVBq0kKet3r8KXnLZCWcD0yQQwHjKkh9x 21 | DvKUzXIW4QTaa/C5YuFl7wKBgHDF68fD/q1+GncOXnfj88GbxpbtGwgXh53//y6k 22 | yvd+viPCIoUC7/Jg2gOuWJJxmmm5FoEKyXkQOtLXIp1SszRG5PA9Mr8bVOp3Y+f+ 23 | h4t/NqNmH7ujauE34wDNymMJHW/RW1v/F0hyl7zKUTV8L48mQvMEZbr2p8OgyChT 24 | LvVBAoGAFPjp50Q3vaZ1aghIjCfSoi0eU5tVbMCAXpwrjLkCGkw8r6U1ILQyMvqw 25 | E57cqoj2hsZ3P7qgQvZox1L7THnAKNYIdM/tj444QmsYudC5wp5hZBEzmmwbIeq8 26 | 3h4V9F7T/1PamwfRhZC3t4wf327HEMu0pZlwARWpuxh4eaXumYM= 27 | -----END RSA PRIVATE KEY----- -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | DocuSign Click API 5 | 6 | Elastic signing (also known as DocuSign Click) lets you capture consent to standard agreement terms with a single click: terms and conditions, terms of service, terms of use, privacy policies, and more. The Click API lets you include this customizable elastic template solution in your DocuSign integrations. # noqa: E501 7 | 8 | OpenAPI spec version: v1 9 | Contact: devcenter@docusign.com 10 | Generated by: https://github.com/swagger-api/swagger-codegen.git 11 | """ 12 | 13 | 14 | from setuptools import setup, find_packages, Command, os # noqa: H301 15 | 16 | NAME = "docusign-click" 17 | VERSION = "1.4.0" 18 | # To install the library, run the following 19 | # 20 | # python setup.py install 21 | # 22 | # prerequisite: setuptools 23 | # http://pypi.python.org/pypi/setuptools 24 | 25 | REQUIRES = ["urllib3 >= 1.15", "six >= 1.8.0", "certifi >= 14.05.14", "python-dateutil >= 2.5.3", "setuptools >= 21.0.0", "PyJWT>=1.7.1", "cryptography>=2.5", "nose>=1.3.7"] 26 | 27 | class CleanCommand(Command): 28 | """Custom clean command to tidy up the project root.""" 29 | user_options = [] 30 | def initialize_options(self): 31 | pass 32 | def finalize_options(self): 33 | pass 34 | def run(self): 35 | os.system('rm -vrf ./build ./dist ./*.pyc ./*.tgz ./*.egg-info') 36 | 37 | this_directory = os.path.abspath(os.path.dirname(__file__)) 38 | with open(os.path.join(this_directory, 'README.md'), encoding='utf-8') as f: 39 | long_description = f.read() 40 | 41 | 42 | setup( 43 | name=NAME, 44 | version=VERSION, 45 | description="DocuSign Click API", 46 | author_email="devcenter@docusign.com", 47 | url="", 48 | keywords=["Swagger", "DocuSign Click API"], 49 | install_requires=REQUIRES, 50 | packages=find_packages(), 51 | include_package_data=True, 52 | cmdclass={ 53 | 'clean': CleanCommand, 54 | }, 55 | long_description=long_description, 56 | long_description_content_type='text/markdown' 57 | ) 58 | -------------------------------------------------------------------------------- /test/unit_tests.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | from __future__ import absolute_import, print_function 4 | from docusign_click import AccountsApi, ApiException 5 | 6 | import base64 7 | import os 8 | import unittest 9 | import docusign_click as docusign 10 | 11 | Username = os.environ.get("USER_NAME") 12 | IntegratorKey = os.environ.get("INTEGRATOR_KEY_JWT") 13 | BaseUrl = "https://demo.docusign.net/clickapi" 14 | OauthHostName = "account-d.docusign.com" 15 | SignTest1File = "{}/docs/SignTest1.pdf".format(os.path.dirname(os.path.abspath(__file__))) 16 | TemplateId = os.environ.get("TEMPLATE_ID") 17 | UserId = os.environ.get("USER_ID") 18 | PrivateKeyBytes = base64.b64decode(os.environ.get("PRIVATE_KEY")) 19 | 20 | 21 | class SdkUnitTests(unittest.TestCase): 22 | 23 | def setUp(self): 24 | self.api_client = docusign.ApiClient(base_path=BaseUrl, oauth_host_name=OauthHostName) 25 | self.api_client.rest_client.pool_manager.clear() 26 | 27 | docusign.configuration.api_client = self.api_client 28 | try: 29 | self.api_client.host = BaseUrl 30 | token = (self.api_client.request_jwt_user_token(client_id=IntegratorKey, 31 | user_id=UserId, 32 | oauth_host_name=OauthHostName, 33 | private_key_bytes=PrivateKeyBytes, 34 | expires_in=3600, 35 | scopes=["signature", "impersonation", 36 | "click.manage", "click.send"])) 37 | self.user_info = self.api_client.get_user_info(token.access_token) 38 | self.api_client.rest_client.pool_manager.clear() 39 | docusign.configuration.api_client = self.api_client 40 | 41 | except ApiException as e: 42 | print("\nException when setting up DocuSign Click API: %s" % e) 43 | self.api_client.rest_client.pool_manager.clear() 44 | 45 | def tearDown(self): 46 | self.api_client.rest_client.pool_manager.clear() 47 | 48 | def testGetClickWraps(self): 49 | # Testing for the UserInfo which is true if auth is successful 50 | try: 51 | print(self.user_info) 52 | self.assertIsNotNone(self.user_info) 53 | self.assertTrue(len(self.user_info.accounts) > 0) 54 | self.assertIsNotNone(self.user_info.accounts[0].account_id) 55 | 56 | accountId = self.user_info.accounts[0].account_id 57 | api = AccountsApi() 58 | clickResponse = api.get_clickwraps(accountId) 59 | 60 | self.assertIsNotNone(clickResponse) 61 | self.assertIsNotNone(len(clickResponse.clickwraps)) 62 | self.assertIsNotNone(clickResponse.clickwraps[0].version_id) 63 | 64 | except ApiException as e: 65 | print("\nException when setting up DocuSign Click API: %s" % e) 66 | self.api_client.rest_client.pool_manager.clear() 67 | 68 | 69 | if __name__ == '__main__': 70 | unittest.main() 71 | -------------------------------------------------------------------------------- /docusign_click/models/__init__.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | # flake8: noqa 4 | """ 5 | DocuSign Click API 6 | 7 | Elastic signing (also known as DocuSign Click) lets you capture consent to standard agreement terms with a single click: terms and conditions, terms of service, terms of use, privacy policies, and more. The Click API lets you include this customizable elastic template solution in your DocuSign integrations. # noqa: E501 8 | 9 | OpenAPI spec version: v1 10 | Contact: devcenter@docusign.com 11 | Generated by: https://github.com/swagger-api/swagger-codegen.git 12 | """ 13 | 14 | 15 | from __future__ import absolute_import 16 | 17 | # import models into model package 18 | from docusign_click.models.agree_button_styles import AgreeButtonStyles 19 | from docusign_click.models.agreement_statement_styles import AgreementStatementStyles 20 | from docusign_click.models.base_agree_button_styles import BaseAgreeButtonStyles 21 | from docusign_click.models.bulk_clickwrap_request import BulkClickwrapRequest 22 | from docusign_click.models.clickwrap_agreements_response import ClickwrapAgreementsResponse 23 | from docusign_click.models.clickwrap_delete_response import ClickwrapDeleteResponse 24 | from docusign_click.models.clickwrap_request import ClickwrapRequest 25 | from docusign_click.models.clickwrap_scheduled_reacceptance import ClickwrapScheduledReacceptance 26 | from docusign_click.models.clickwrap_transfer_request import ClickwrapTransferRequest 27 | from docusign_click.models.clickwrap_version import ClickwrapVersion 28 | from docusign_click.models.clickwrap_version_delete_response import ClickwrapVersionDeleteResponse 29 | from docusign_click.models.clickwrap_version_response import ClickwrapVersionResponse 30 | from docusign_click.models.clickwrap_version_summary_response import ClickwrapVersionSummaryResponse 31 | from docusign_click.models.clickwrap_versions_delete_response import ClickwrapVersionsDeleteResponse 32 | from docusign_click.models.clickwrap_versions_paged_response import ClickwrapVersionsPagedResponse 33 | from docusign_click.models.clickwrap_versions_response import ClickwrapVersionsResponse 34 | from docusign_click.models.clickwraps_delete_response import ClickwrapsDeleteResponse 35 | from docusign_click.models.container_styles import ContainerStyles 36 | from docusign_click.models.data_field import DataField 37 | from docusign_click.models.disclosure_link_styles import DisclosureLinkStyles 38 | from docusign_click.models.display_settings import DisplaySettings 39 | from docusign_click.models.document import Document 40 | from docusign_click.models.document_link_styles import DocumentLinkStyles 41 | from docusign_click.models.document_link_styles_focus import DocumentLinkStylesFocus 42 | from docusign_click.models.error_details import ErrorDetails 43 | from docusign_click.models.header_styles import HeaderStyles 44 | from docusign_click.models.service_information import ServiceInformation 45 | from docusign_click.models.service_version import ServiceVersion 46 | from docusign_click.models.user_agreement_request import UserAgreementRequest 47 | from docusign_click.models.user_agreement_response import UserAgreementResponse 48 | from docusign_click.models.user_agreement_response_style import UserAgreementResponseStyle 49 | -------------------------------------------------------------------------------- /docusign_click/__init__.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | # flake8: noqa 4 | 5 | """ 6 | DocuSign Click API 7 | 8 | Elastic signing (also known as DocuSign Click) lets you capture consent to standard agreement terms with a single click: terms and conditions, terms of service, terms of use, privacy policies, and more. The Click API lets you include this customizable elastic template solution in your DocuSign integrations. # noqa: E501 9 | 10 | OpenAPI spec version: v1 11 | Contact: devcenter@docusign.com 12 | Generated by: https://github.com/swagger-api/swagger-codegen.git 13 | """ 14 | 15 | 16 | from __future__ import absolute_import 17 | 18 | # import apis into sdk package 19 | from .apis.accounts_api import AccountsApi 20 | 21 | # import ApiClient 22 | from .client.api_client import ApiClient 23 | from .client.configuration import Configuration 24 | from .client.api_exception import ApiException 25 | 26 | from .client.auth.oauth import OAuth 27 | from .client.auth.oauth import OAuthToken 28 | from .client.auth.oauth import Account 29 | from .client.auth.oauth import Organization 30 | from .client.auth.oauth import Link 31 | 32 | # import models into sdk package 33 | from docusign_click.models.agree_button_styles import AgreeButtonStyles 34 | from docusign_click.models.agreement_statement_styles import AgreementStatementStyles 35 | from docusign_click.models.base_agree_button_styles import BaseAgreeButtonStyles 36 | from docusign_click.models.bulk_clickwrap_request import BulkClickwrapRequest 37 | from docusign_click.models.clickwrap_agreements_response import ClickwrapAgreementsResponse 38 | from docusign_click.models.clickwrap_delete_response import ClickwrapDeleteResponse 39 | from docusign_click.models.clickwrap_request import ClickwrapRequest 40 | from docusign_click.models.clickwrap_scheduled_reacceptance import ClickwrapScheduledReacceptance 41 | from docusign_click.models.clickwrap_transfer_request import ClickwrapTransferRequest 42 | from docusign_click.models.clickwrap_version import ClickwrapVersion 43 | from docusign_click.models.clickwrap_version_delete_response import ClickwrapVersionDeleteResponse 44 | from docusign_click.models.clickwrap_version_response import ClickwrapVersionResponse 45 | from docusign_click.models.clickwrap_version_summary_response import ClickwrapVersionSummaryResponse 46 | from docusign_click.models.clickwrap_versions_delete_response import ClickwrapVersionsDeleteResponse 47 | from docusign_click.models.clickwrap_versions_paged_response import ClickwrapVersionsPagedResponse 48 | from docusign_click.models.clickwrap_versions_response import ClickwrapVersionsResponse 49 | from docusign_click.models.clickwraps_delete_response import ClickwrapsDeleteResponse 50 | from docusign_click.models.container_styles import ContainerStyles 51 | from docusign_click.models.data_field import DataField 52 | from docusign_click.models.disclosure_link_styles import DisclosureLinkStyles 53 | from docusign_click.models.display_settings import DisplaySettings 54 | from docusign_click.models.document import Document 55 | from docusign_click.models.document_link_styles import DocumentLinkStyles 56 | from docusign_click.models.document_link_styles_focus import DocumentLinkStylesFocus 57 | from docusign_click.models.error_details import ErrorDetails 58 | from docusign_click.models.header_styles import HeaderStyles 59 | from docusign_click.models.service_information import ServiceInformation 60 | from docusign_click.models.service_version import ServiceVersion 61 | from docusign_click.models.user_agreement_request import UserAgreementRequest 62 | from docusign_click.models.user_agreement_response import UserAgreementResponse 63 | from docusign_click.models.user_agreement_response_style import UserAgreementResponseStyle 64 | 65 | 66 | configuration = Configuration() -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # The Official DocuSign Click Python Client 2 | 3 | [![PyPI version][pypi-image]][pypi-url] 4 | 5 | [![Build status][travis-image]][travis-url] 6 | 7 | [PyPI module](https://pypi.python.org/pypi/docusign_click) that wraps the DocuSign Click API 8 | 9 | [Documentation about the DocuSign Click API](https://developers.docusign.com/) 10 | 11 | ## Requirements 12 | 13 | - Python 2.7 (3.7+ recommended) 14 | - Free [Developer Sandbox](https://go.docusign.com/sandbox/productshot/?elqCampaignId=16531) 15 | 16 | ## Compatibility 17 | 18 | - Python 2.7+ 19 | 20 | ## Installation 21 | 22 | ### Path Setup: 23 | 24 | 1. Locate your Python installation, also referred to as a **site-packages** folder. This folder is usually labeled in a format of Python{VersionNumber}. 25 | 26 | **Examples:** 27 | 28 | - **Unix/Linux:** /usr/lib/python2.7 29 | - **Mac:** /Library/Frameworks/Python.framework/Versions/2.7/lib/python2.7 30 | - **Windows:** C:\Users\{username}\AppData\Local\Programs\Python\Python37 31 | 32 | 1. Add the path to your Python folder as an environment variable. 33 | 34 | **Unix/Linux:** 35 | 36 | - Type the following command into your console: 37 | **export PYTHONPATH = "${PYTHONPATH}:.:/path/to/site-packages"** 38 | - Optionally, you can add this command to your system profile, which will run the command each time Python is launched. 39 | 40 | **Windows:** 41 | 42 |
    43 |
  1. Open the Windows Control Panel.
    2. 44 |
  2. Under the System and Security category, open the System
    3. 45 |
  3. Select Advanced System Settings to open the System Properties dialog box.
    4. 46 |
  4. On the Advanced tab, select the Environmental Variables button at the lower-right corner. 47 |
      48 |
    1. Check if PYTHONPATH has been added as a system variable.
      2. 49 |
    2. If it has not, select New to add it. The variable you add is the path to the site-packages
      3. 50 |
    51 |
    5. 52 |
53 | 54 | **Note:** If you are still unable to reference python or pip via your command console,you can also add the path to the site-packages folder to the built-in environment variable labeled **Path** , which will take effect the next time you start your machine. 55 | 56 | ### Install via PIP: 57 | 58 | 1. In your command console, type: 59 | pip install docusign-click 60 | 61 | Note: This may require the command console be elevated. You can accomplish this via sudoin Unix/Linux, or by running the command console as an administrator in Windows. 62 | 63 | ## Dependencies 64 | 65 | This client has the following external dependencies: 66 | 67 | - certifi v14.05.14+ 68 | - six v1.8.0+ 69 | - python\_dateutil v2.5.3+ 70 | - setuptools v21.0.0+ 71 | - urllib3 v1.15.1+ 72 | - jwcrypto v0.4.2+ 73 | - py-oauth2 v0.0.10+ 74 | 75 | 76 | ## Support 77 | 78 | Log issues against this client through GitHub. We also have an [active developer community on Stack Overflow](https://stackoverflow.com/questions/tagged/docusignapi). 79 | 80 | ## License 81 | 82 | The DocuSign Python Client is licensed under the [MIT License](https://github.com/docusign/docusign-python-client/blob/master/LICENSE). 83 | 84 | 85 | [pypi-image]: https://img.shields.io/pypi/v/docusign_click.svg?style=flat 86 | [pypi-url]: https://pypi.python.org/pypi/docusign_click 87 | [downloads-image]: https://img.shields.io/pypi/dm/docusign_click.svg?style=flat 88 | [downloads-url]: https://pypi.python.org/pypi/docusign_click 89 | [travis-image]: https://img.shields.io/travis/docusign/docusign-click-python-client.svg?style=flat 90 | [travis-url]: https://travis-ci.org/docusign/docusign-click-python-client 91 | -------------------------------------------------------------------------------- /docusign_click/models/document_conversion_request.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | 5 | No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501 6 | 7 | OpenAPI spec version: v1 8 | 9 | Generated by: https://github.com/swagger-api/swagger-codegen.git 10 | """ 11 | 12 | 13 | import pprint 14 | import re # noqa: F401 15 | 16 | import six 17 | 18 | 19 | class DocumentConversionRequest(object): 20 | """NOTE: This class is auto generated by the swagger code generator program. 21 | 22 | Do not edit the class manually. 23 | """ 24 | 25 | """ 26 | Attributes: 27 | swagger_types (dict): The key is attribute name 28 | and the value is attribute type. 29 | attribute_map (dict): The key is attribute name 30 | and the value is json key in definition. 31 | """ 32 | swagger_types = { 33 | 'documents': 'list[ConversionDocument]' 34 | } 35 | 36 | attribute_map = { 37 | 'documents': 'documents' 38 | } 39 | 40 | def __init__(self, documents=None): # noqa: E501 41 | """DocumentConversionRequest - a model defined in Swagger""" # noqa: E501 42 | 43 | self._documents = None 44 | self.discriminator = None 45 | 46 | if documents is not None: 47 | self.documents = documents 48 | 49 | @property 50 | def documents(self): 51 | """Gets the documents of this DocumentConversionRequest. # noqa: E501 52 | 53 | # noqa: E501 54 | 55 | :return: The documents of this DocumentConversionRequest. # noqa: E501 56 | :rtype: list[ConversionDocument] 57 | """ 58 | return self._documents 59 | 60 | @documents.setter 61 | def documents(self, documents): 62 | """Sets the documents of this DocumentConversionRequest. 63 | 64 | # noqa: E501 65 | 66 | :param documents: The documents of this DocumentConversionRequest. # noqa: E501 67 | :type: list[ConversionDocument] 68 | """ 69 | 70 | self._documents = documents 71 | 72 | def to_dict(self): 73 | """Returns the model properties as a dict""" 74 | result = {} 75 | 76 | for attr, _ in six.iteritems(self.swagger_types): 77 | value = getattr(self, attr) 78 | if isinstance(value, list): 79 | result[attr] = list(map( 80 | lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 81 | value 82 | )) 83 | elif hasattr(value, "to_dict"): 84 | result[attr] = value.to_dict() 85 | elif isinstance(value, dict): 86 | result[attr] = dict(map( 87 | lambda item: (item[0], item[1].to_dict()) 88 | if hasattr(item[1], "to_dict") else item, 89 | value.items() 90 | )) 91 | else: 92 | result[attr] = value 93 | if issubclass(DocumentConversionRequest, dict): 94 | for key, value in self.items(): 95 | result[key] = value 96 | 97 | return result 98 | 99 | def to_str(self): 100 | """Returns the string representation of the model""" 101 | return pprint.pformat(self.to_dict()) 102 | 103 | def __repr__(self): 104 | """For `print` and `pprint`""" 105 | return self.to_str() 106 | 107 | def __eq__(self, other): 108 | """Returns true if both objects are equal""" 109 | if not isinstance(other, DocumentConversionRequest): 110 | return False 111 | 112 | return self.__dict__ == other.__dict__ 113 | 114 | def __ne__(self, other): 115 | """Returns true if both objects are not equal""" 116 | return not self == other 117 | -------------------------------------------------------------------------------- /docusign_click/models/document_conversion_response.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | 5 | No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501 6 | 7 | OpenAPI spec version: v1 8 | 9 | Generated by: https://github.com/swagger-api/swagger-codegen.git 10 | """ 11 | 12 | 13 | import pprint 14 | import re # noqa: F401 15 | 16 | import six 17 | 18 | 19 | class DocumentConversionResponse(object): 20 | """NOTE: This class is auto generated by the swagger code generator program. 21 | 22 | Do not edit the class manually. 23 | """ 24 | 25 | """ 26 | Attributes: 27 | swagger_types (dict): The key is attribute name 28 | and the value is attribute type. 29 | attribute_map (dict): The key is attribute name 30 | and the value is json key in definition. 31 | """ 32 | swagger_types = { 33 | 'html_results': 'list[HtmlResult]' 34 | } 35 | 36 | attribute_map = { 37 | 'html_results': 'htmlResults' 38 | } 39 | 40 | def __init__(self, html_results=None): # noqa: E501 41 | """DocumentConversionResponse - a model defined in Swagger""" # noqa: E501 42 | 43 | self._html_results = None 44 | self.discriminator = None 45 | 46 | if html_results is not None: 47 | self.html_results = html_results 48 | 49 | @property 50 | def html_results(self): 51 | """Gets the html_results of this DocumentConversionResponse. # noqa: E501 52 | 53 | # noqa: E501 54 | 55 | :return: The html_results of this DocumentConversionResponse. # noqa: E501 56 | :rtype: list[HtmlResult] 57 | """ 58 | return self._html_results 59 | 60 | @html_results.setter 61 | def html_results(self, html_results): 62 | """Sets the html_results of this DocumentConversionResponse. 63 | 64 | # noqa: E501 65 | 66 | :param html_results: The html_results of this DocumentConversionResponse. # noqa: E501 67 | :type: list[HtmlResult] 68 | """ 69 | 70 | self._html_results = html_results 71 | 72 | def to_dict(self): 73 | """Returns the model properties as a dict""" 74 | result = {} 75 | 76 | for attr, _ in six.iteritems(self.swagger_types): 77 | value = getattr(self, attr) 78 | if isinstance(value, list): 79 | result[attr] = list(map( 80 | lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 81 | value 82 | )) 83 | elif hasattr(value, "to_dict"): 84 | result[attr] = value.to_dict() 85 | elif isinstance(value, dict): 86 | result[attr] = dict(map( 87 | lambda item: (item[0], item[1].to_dict()) 88 | if hasattr(item[1], "to_dict") else item, 89 | value.items() 90 | )) 91 | else: 92 | result[attr] = value 93 | if issubclass(DocumentConversionResponse, dict): 94 | for key, value in self.items(): 95 | result[key] = value 96 | 97 | return result 98 | 99 | def to_str(self): 100 | """Returns the string representation of the model""" 101 | return pprint.pformat(self.to_dict()) 102 | 103 | def __repr__(self): 104 | """For `print` and `pprint`""" 105 | return self.to_str() 106 | 107 | def __eq__(self, other): 108 | """Returns true if both objects are equal""" 109 | if not isinstance(other, DocumentConversionResponse): 110 | return False 111 | 112 | return self.__dict__ == other.__dict__ 113 | 114 | def __ne__(self, other): 115 | """Returns true if both objects are not equal""" 116 | return not self == other 117 | -------------------------------------------------------------------------------- /docusign_click/models/html_result.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | 5 | No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501 6 | 7 | OpenAPI spec version: v1 8 | 9 | Generated by: https://github.com/swagger-api/swagger-codegen.git 10 | """ 11 | 12 | 13 | import pprint 14 | import re # noqa: F401 15 | 16 | import six 17 | 18 | 19 | class HtmlResult(object): 20 | """NOTE: This class is auto generated by the swagger code generator program. 21 | 22 | Do not edit the class manually. 23 | """ 24 | 25 | """ 26 | Attributes: 27 | swagger_types (dict): The key is attribute name 28 | and the value is attribute type. 29 | attribute_map (dict): The key is attribute name 30 | and the value is json key in definition. 31 | """ 32 | swagger_types = { 33 | 'file_name': 'str', 34 | 'html': 'str' 35 | } 36 | 37 | attribute_map = { 38 | 'file_name': 'fileName', 39 | 'html': 'html' 40 | } 41 | 42 | def __init__(self, file_name=None, html=None): # noqa: E501 43 | """HtmlResult - a model defined in Swagger""" # noqa: E501 44 | 45 | self._file_name = None 46 | self._html = None 47 | self.discriminator = None 48 | 49 | if file_name is not None: 50 | self.file_name = file_name 51 | if html is not None: 52 | self.html = html 53 | 54 | @property 55 | def file_name(self): 56 | """Gets the file_name of this HtmlResult. # noqa: E501 57 | 58 | # noqa: E501 59 | 60 | :return: The file_name of this HtmlResult. # noqa: E501 61 | :rtype: str 62 | """ 63 | return self._file_name 64 | 65 | @file_name.setter 66 | def file_name(self, file_name): 67 | """Sets the file_name of this HtmlResult. 68 | 69 | # noqa: E501 70 | 71 | :param file_name: The file_name of this HtmlResult. # noqa: E501 72 | :type: str 73 | """ 74 | 75 | self._file_name = file_name 76 | 77 | @property 78 | def html(self): 79 | """Gets the html of this HtmlResult. # noqa: E501 80 | 81 | # noqa: E501 82 | 83 | :return: The html of this HtmlResult. # noqa: E501 84 | :rtype: str 85 | """ 86 | return self._html 87 | 88 | @html.setter 89 | def html(self, html): 90 | """Sets the html of this HtmlResult. 91 | 92 | # noqa: E501 93 | 94 | :param html: The html of this HtmlResult. # noqa: E501 95 | :type: str 96 | """ 97 | 98 | self._html = html 99 | 100 | def to_dict(self): 101 | """Returns the model properties as a dict""" 102 | result = {} 103 | 104 | for attr, _ in six.iteritems(self.swagger_types): 105 | value = getattr(self, attr) 106 | if isinstance(value, list): 107 | result[attr] = list(map( 108 | lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 109 | value 110 | )) 111 | elif hasattr(value, "to_dict"): 112 | result[attr] = value.to_dict() 113 | elif isinstance(value, dict): 114 | result[attr] = dict(map( 115 | lambda item: (item[0], item[1].to_dict()) 116 | if hasattr(item[1], "to_dict") else item, 117 | value.items() 118 | )) 119 | else: 120 | result[attr] = value 121 | if issubclass(HtmlResult, dict): 122 | for key, value in self.items(): 123 | result[key] = value 124 | 125 | return result 126 | 127 | def to_str(self): 128 | """Returns the string representation of the model""" 129 | return pprint.pformat(self.to_dict()) 130 | 131 | def __repr__(self): 132 | """For `print` and `pprint`""" 133 | return self.to_str() 134 | 135 | def __eq__(self, other): 136 | """Returns true if both objects are equal""" 137 | if not isinstance(other, HtmlResult): 138 | return False 139 | 140 | return self.__dict__ == other.__dict__ 141 | 142 | def __ne__(self, other): 143 | """Returns true if both objects are not equal""" 144 | return not self == other 145 | -------------------------------------------------------------------------------- /docusign_click/models/clickwraps_delete_response.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | DocuSign Click API 5 | 6 | Elastic signing (also known as DocuSign Click) lets you capture consent to standard agreement terms with a single click: terms and conditions, terms of service, terms of use, privacy policies, and more. The Click API lets you include this customizable elastic template solution in your DocuSign integrations. # noqa: E501 7 | 8 | OpenAPI spec version: v1 9 | Contact: devcenter@docusign.com 10 | Generated by: https://github.com/swagger-api/swagger-codegen.git 11 | """ 12 | 13 | 14 | import pprint 15 | import re # noqa: F401 16 | 17 | import six 18 | 19 | from docusign_click.client.configuration import Configuration 20 | 21 | 22 | class ClickwrapsDeleteResponse(object): 23 | """NOTE: This class is auto generated by the swagger code generator program. 24 | 25 | Do not edit the class manually. 26 | """ 27 | 28 | """ 29 | Attributes: 30 | swagger_types (dict): The key is attribute name 31 | and the value is attribute type. 32 | attribute_map (dict): The key is attribute name 33 | and the value is json key in definition. 34 | """ 35 | swagger_types = { 36 | 'clickwraps': 'list[ClickwrapDeleteResponse]' 37 | } 38 | 39 | attribute_map = { 40 | 'clickwraps': 'clickwraps' 41 | } 42 | 43 | def __init__(self, _configuration=None, **kwargs): # noqa: E501 44 | """ClickwrapsDeleteResponse - a model defined in Swagger""" # noqa: E501 45 | if _configuration is None: 46 | _configuration = Configuration() 47 | self._configuration = _configuration 48 | 49 | self._clickwraps = None 50 | self.discriminator = None 51 | 52 | setattr(self, "_{}".format('clickwraps'), kwargs.get('clickwraps', None)) 53 | 54 | @property 55 | def clickwraps(self): 56 | """Gets the clickwraps of this ClickwrapsDeleteResponse. # noqa: E501 57 | 58 | An array of clickwrap deletion results. # noqa: E501 59 | 60 | :return: The clickwraps of this ClickwrapsDeleteResponse. # noqa: E501 61 | :rtype: list[ClickwrapDeleteResponse] 62 | """ 63 | return self._clickwraps 64 | 65 | @clickwraps.setter 66 | def clickwraps(self, clickwraps): 67 | """Sets the clickwraps of this ClickwrapsDeleteResponse. 68 | 69 | An array of clickwrap deletion results. # noqa: E501 70 | 71 | :param clickwraps: The clickwraps of this ClickwrapsDeleteResponse. # noqa: E501 72 | :type: list[ClickwrapDeleteResponse] 73 | """ 74 | 75 | self._clickwraps = clickwraps 76 | 77 | def to_dict(self): 78 | """Returns the model properties as a dict""" 79 | result = {} 80 | 81 | for attr, _ in six.iteritems(self.swagger_types): 82 | value = getattr(self, attr) 83 | if isinstance(value, list): 84 | result[attr] = list(map( 85 | lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 86 | value 87 | )) 88 | elif hasattr(value, "to_dict"): 89 | result[attr] = value.to_dict() 90 | elif isinstance(value, dict): 91 | result[attr] = dict(map( 92 | lambda item: (item[0], item[1].to_dict()) 93 | if hasattr(item[1], "to_dict") else item, 94 | value.items() 95 | )) 96 | else: 97 | result[attr] = value 98 | if issubclass(ClickwrapsDeleteResponse, dict): 99 | for key, value in self.items(): 100 | result[key] = value 101 | 102 | return result 103 | 104 | def to_str(self): 105 | """Returns the string representation of the model""" 106 | return pprint.pformat(self.to_dict()) 107 | 108 | def __repr__(self): 109 | """For `print` and `pprint`""" 110 | return self.to_str() 111 | 112 | def __eq__(self, other): 113 | """Returns true if both objects are equal""" 114 | if not isinstance(other, ClickwrapsDeleteResponse): 115 | return False 116 | 117 | return self.to_dict() == other.to_dict() 118 | 119 | def __ne__(self, other): 120 | """Returns true if both objects are not equal""" 121 | if not isinstance(other, ClickwrapsDeleteResponse): 122 | return True 123 | 124 | return self.to_dict() != other.to_dict() 125 | -------------------------------------------------------------------------------- /docusign_click/models/disclosure_link_styles.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | DocuSign Click API 5 | 6 | Elastic signing (also known as DocuSign Click) lets you capture consent to standard agreement terms with a single click: terms and conditions, terms of service, terms of use, privacy policies, and more. The Click API lets you include this customizable elastic template solution in your DocuSign integrations. # noqa: E501 7 | 8 | OpenAPI spec version: v1 9 | Contact: devcenter@docusign.com 10 | Generated by: https://github.com/swagger-api/swagger-codegen.git 11 | """ 12 | 13 | 14 | import pprint 15 | import re # noqa: F401 16 | 17 | import six 18 | 19 | from docusign_click.client.configuration import Configuration 20 | 21 | 22 | class DisclosureLinkStyles(object): 23 | """NOTE: This class is auto generated by the swagger code generator program. 24 | 25 | Do not edit the class manually. 26 | """ 27 | 28 | """ 29 | Attributes: 30 | swagger_types (dict): The key is attribute name 31 | and the value is attribute type. 32 | attribute_map (dict): The key is attribute name 33 | and the value is json key in definition. 34 | """ 35 | swagger_types = { 36 | 'display': 'str' 37 | } 38 | 39 | attribute_map = { 40 | 'display': 'display' 41 | } 42 | 43 | def __init__(self, _configuration=None, **kwargs): # noqa: E501 44 | """DisclosureLinkStyles - a model defined in Swagger""" # noqa: E501 45 | if _configuration is None: 46 | _configuration = Configuration() 47 | self._configuration = _configuration 48 | 49 | self._display = None 50 | self.discriminator = None 51 | 52 | setattr(self, "_{}".format('display'), kwargs.get('display', None)) 53 | 54 | @property 55 | def display(self): 56 | """Gets the display of this DisclosureLinkStyles. # noqa: E501 57 | 58 | 59 | :return: The display of this DisclosureLinkStyles. # noqa: E501 60 | :rtype: str 61 | """ 62 | return self._display 63 | 64 | @display.setter 65 | def display(self, display): 66 | """Sets the display of this DisclosureLinkStyles. 67 | 68 | 69 | :param display: The display of this DisclosureLinkStyles. # noqa: E501 70 | :type: str 71 | """ 72 | allowed_values = ["none"] # noqa: E501 73 | if (self._configuration.client_side_validation and 74 | display not in allowed_values): 75 | raise ValueError( 76 | "Invalid value for `display` ({0}), must be one of {1}" # noqa: E501 77 | .format(display, allowed_values) 78 | ) 79 | 80 | self._display = display 81 | 82 | def to_dict(self): 83 | """Returns the model properties as a dict""" 84 | result = {} 85 | 86 | for attr, _ in six.iteritems(self.swagger_types): 87 | value = getattr(self, attr) 88 | if isinstance(value, list): 89 | result[attr] = list(map( 90 | lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 91 | value 92 | )) 93 | elif hasattr(value, "to_dict"): 94 | result[attr] = value.to_dict() 95 | elif isinstance(value, dict): 96 | result[attr] = dict(map( 97 | lambda item: (item[0], item[1].to_dict()) 98 | if hasattr(item[1], "to_dict") else item, 99 | value.items() 100 | )) 101 | else: 102 | result[attr] = value 103 | if issubclass(DisclosureLinkStyles, dict): 104 | for key, value in self.items(): 105 | result[key] = value 106 | 107 | return result 108 | 109 | def to_str(self): 110 | """Returns the string representation of the model""" 111 | return pprint.pformat(self.to_dict()) 112 | 113 | def __repr__(self): 114 | """For `print` and `pprint`""" 115 | return self.to_str() 116 | 117 | def __eq__(self, other): 118 | """Returns true if both objects are equal""" 119 | if not isinstance(other, DisclosureLinkStyles): 120 | return False 121 | 122 | return self.to_dict() == other.to_dict() 123 | 124 | def __ne__(self, other): 125 | """Returns true if both objects are not equal""" 126 | if not isinstance(other, DisclosureLinkStyles): 127 | return True 128 | 129 | return self.to_dict() != other.to_dict() 130 | -------------------------------------------------------------------------------- /test/test_oauth.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | # flake8: noqa 4 | 5 | """ 6 | DocuSign Click API - v2 7 | 8 | An API for an integrator to access the features of DocuSign Click # noqa: E501 9 | 10 | OpenAPI spec version: v2 11 | Contact: devcenter@docusign.com 12 | """ 13 | 14 | from __future__ import absolute_import 15 | 16 | import base64 17 | import os 18 | import unittest 19 | 20 | from docusign_click.client.api_client import ApiClient 21 | from docusign_click.client.auth.oauth import OAuthToken 22 | 23 | 24 | class TestConfig(object): 25 | def __init__(self, user_name=None, client_secret =None, user_id=None, integrator_key=None, host=None, recipient_email=None, 26 | recipient_name=None, template_role_name=None, template_id=None, return_url=None, redirect_uri=None): 27 | self.user_name = user_name if user_name else os.environ.get("USER_NAME") 28 | self.client_secret = client_secret if client_secret else os.environ.get("CLIENT_SECRET") 29 | self.integrator_key = integrator_key if integrator_key else os.environ.get("INTEGRATOR_KEY_JWT") 30 | self.host = host if host else "https://demo.docusign.net/clickapi" 31 | self.recipient_email = recipient_email if recipient_email else os.environ.get("USER_NAME") 32 | self.recipient_name = recipient_name if recipient_name else os.environ.get("USER_NAME") 33 | self.template_role_name = template_role_name if template_role_name else os.environ.get("USER_NAME") 34 | self.template_id = template_id if template_id else os.environ.get("TEMPLATE_ID") 35 | self.return_url = return_url if return_url else os.environ.get("REDIRECT_URI") 36 | self.user_id = user_id if user_id else os.environ.get("USER_ID") 37 | self.redirect_uri = redirect_uri if redirect_uri else os.environ.get("REDIRECT_URI") 38 | 39 | self.oauth_host_name = "account-d.docusign.com" 40 | self.private_key_bytes = base64.b64decode(os.environ.get("PRIVATE_KEY")) 41 | self.expires_in = 3600 42 | 43 | 44 | class TestOauth(unittest.TestCase): 45 | """ AccountBillingPlan unit test stubs """ 46 | 47 | def setUp(self): 48 | self.test_config = TestConfig() 49 | self.api_client = ApiClient(oauth_host_name=self.test_config.oauth_host_name) 50 | self.api_client.set_base_path("https://demo.click.docusign.com") 51 | self.api_client.set_oauth_host_name(self.test_config.oauth_host_name) 52 | 53 | def test_oauth_uri(self): 54 | self.api_client.get_oauth_host_name() 55 | uri = self.api_client.get_authorization_uri(client_id=self.test_config.integrator_key, 56 | redirect_uri=self.test_config.redirect_uri, 57 | scopes=["signature", "impersonation", 58 | "click.manage", "click.send"], 59 | response_type='code') 60 | self.assertTrue(isinstance(uri, str)) 61 | self.api_client.rest_client.pool_manager.clear() 62 | 63 | def test_jwt_application(self): 64 | token_obj = self.api_client.request_jwt_application_token(client_id=self.test_config.integrator_key, 65 | oauth_host_name=self.test_config.oauth_host_name, 66 | private_key_bytes=self.test_config.private_key_bytes, 67 | expires_in=self.test_config.expires_in) 68 | self.assertTrue(isinstance(token_obj, OAuthToken)) 69 | self.api_client.rest_client.pool_manager.clear() 70 | 71 | def test_jwt_user(self): 72 | token_obj = self.api_client.request_jwt_user_token(client_id=self.test_config.integrator_key, 73 | user_id=self.test_config.user_id, 74 | oauth_host_name=self.api_client.get_oauth_host_name(), 75 | private_key_bytes=self.test_config.private_key_bytes, 76 | expires_in=self.test_config.expires_in 77 | ) 78 | self.assertTrue(isinstance(token_obj, OAuthToken)) 79 | self.api_client.rest_client.pool_manager.clear() 80 | 81 | def test_authorization_code_login(self): 82 | self.api_client.get_oauth_host_name() 83 | uri = self.api_client.get_authorization_uri(client_id=self.test_config.integrator_key, 84 | redirect_uri=self.test_config.redirect_uri, 85 | scopes=["signature"], 86 | response_type='code') 87 | self.assertTrue(isinstance(uri, str)) 88 | self.api_client.rest_client.pool_manager.clear() 89 | 90 | 91 | if __name__ == '__main__': 92 | unittest.main() 93 | -------------------------------------------------------------------------------- /docusign_click/models/error_details.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | DocuSign Click API 5 | 6 | Elastic signing (also known as DocuSign Click) lets you capture consent to standard agreement terms with a single click: terms and conditions, terms of service, terms of use, privacy policies, and more. The Click API lets you include this customizable elastic template solution in your DocuSign integrations. # noqa: E501 7 | 8 | OpenAPI spec version: v1 9 | Contact: devcenter@docusign.com 10 | Generated by: https://github.com/swagger-api/swagger-codegen.git 11 | """ 12 | 13 | 14 | import pprint 15 | import re # noqa: F401 16 | 17 | import six 18 | 19 | from docusign_click.client.configuration import Configuration 20 | 21 | 22 | class ErrorDetails(object): 23 | """NOTE: This class is auto generated by the swagger code generator program. 24 | 25 | Do not edit the class manually. 26 | """ 27 | 28 | """ 29 | Attributes: 30 | swagger_types (dict): The key is attribute name 31 | and the value is attribute type. 32 | attribute_map (dict): The key is attribute name 33 | and the value is json key in definition. 34 | """ 35 | swagger_types = { 36 | 'error_code': 'str', 37 | 'message': 'str' 38 | } 39 | 40 | attribute_map = { 41 | 'error_code': 'errorCode', 42 | 'message': 'message' 43 | } 44 | 45 | def __init__(self, _configuration=None, **kwargs): # noqa: E501 46 | """ErrorDetails - a model defined in Swagger""" # noqa: E501 47 | if _configuration is None: 48 | _configuration = Configuration() 49 | self._configuration = _configuration 50 | 51 | self._error_code = None 52 | self._message = None 53 | self.discriminator = None 54 | 55 | setattr(self, "_{}".format('error_code'), kwargs.get('error_code', None)) 56 | setattr(self, "_{}".format('message'), kwargs.get('message', None)) 57 | 58 | @property 59 | def error_code(self): 60 | """Gets the error_code of this ErrorDetails. # noqa: E501 61 | 62 | The error code. # noqa: E501 63 | 64 | :return: The error_code of this ErrorDetails. # noqa: E501 65 | :rtype: str 66 | """ 67 | return self._error_code 68 | 69 | @error_code.setter 70 | def error_code(self, error_code): 71 | """Sets the error_code of this ErrorDetails. 72 | 73 | The error code. # noqa: E501 74 | 75 | :param error_code: The error_code of this ErrorDetails. # noqa: E501 76 | :type: str 77 | """ 78 | 79 | self._error_code = error_code 80 | 81 | @property 82 | def message(self): 83 | """Gets the message of this ErrorDetails. # noqa: E501 84 | 85 | The error message. # noqa: E501 86 | 87 | :return: The message of this ErrorDetails. # noqa: E501 88 | :rtype: str 89 | """ 90 | return self._message 91 | 92 | @message.setter 93 | def message(self, message): 94 | """Sets the message of this ErrorDetails. 95 | 96 | The error message. # noqa: E501 97 | 98 | :param message: The message of this ErrorDetails. # noqa: E501 99 | :type: str 100 | """ 101 | 102 | self._message = message 103 | 104 | def to_dict(self): 105 | """Returns the model properties as a dict""" 106 | result = {} 107 | 108 | for attr, _ in six.iteritems(self.swagger_types): 109 | value = getattr(self, attr) 110 | if isinstance(value, list): 111 | result[attr] = list(map( 112 | lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 113 | value 114 | )) 115 | elif hasattr(value, "to_dict"): 116 | result[attr] = value.to_dict() 117 | elif isinstance(value, dict): 118 | result[attr] = dict(map( 119 | lambda item: (item[0], item[1].to_dict()) 120 | if hasattr(item[1], "to_dict") else item, 121 | value.items() 122 | )) 123 | else: 124 | result[attr] = value 125 | if issubclass(ErrorDetails, dict): 126 | for key, value in self.items(): 127 | result[key] = value 128 | 129 | return result 130 | 131 | def to_str(self): 132 | """Returns the string representation of the model""" 133 | return pprint.pformat(self.to_dict()) 134 | 135 | def __repr__(self): 136 | """For `print` and `pprint`""" 137 | return self.to_str() 138 | 139 | def __eq__(self, other): 140 | """Returns true if both objects are equal""" 141 | if not isinstance(other, ErrorDetails): 142 | return False 143 | 144 | return self.to_dict() == other.to_dict() 145 | 146 | def __ne__(self, other): 147 | """Returns true if both objects are not equal""" 148 | if not isinstance(other, ErrorDetails): 149 | return True 150 | 151 | return self.to_dict() != other.to_dict() 152 | -------------------------------------------------------------------------------- /docusign_click/models/service_version.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | DocuSign Click API 5 | 6 | Elastic signing (also known as DocuSign Click) lets you capture consent to standard agreement terms with a single click: terms and conditions, terms of service, terms of use, privacy policies, and more. The Click API lets you include this customizable elastic template solution in your DocuSign integrations. # noqa: E501 7 | 8 | OpenAPI spec version: v1 9 | Contact: devcenter@docusign.com 10 | Generated by: https://github.com/swagger-api/swagger-codegen.git 11 | """ 12 | 13 | 14 | import pprint 15 | import re # noqa: F401 16 | 17 | import six 18 | 19 | from docusign_click.client.configuration import Configuration 20 | 21 | 22 | class ServiceVersion(object): 23 | """NOTE: This class is auto generated by the swagger code generator program. 24 | 25 | Do not edit the class manually. 26 | """ 27 | 28 | """ 29 | Attributes: 30 | swagger_types (dict): The key is attribute name 31 | and the value is attribute type. 32 | attribute_map (dict): The key is attribute name 33 | and the value is json key in definition. 34 | """ 35 | swagger_types = { 36 | 'version': 'str', 37 | 'version_url': 'str' 38 | } 39 | 40 | attribute_map = { 41 | 'version': 'version', 42 | 'version_url': 'versionUrl' 43 | } 44 | 45 | def __init__(self, _configuration=None, **kwargs): # noqa: E501 46 | """ServiceVersion - a model defined in Swagger""" # noqa: E501 47 | if _configuration is None: 48 | _configuration = Configuration() 49 | self._configuration = _configuration 50 | 51 | self._version = None 52 | self._version_url = None 53 | self.discriminator = None 54 | 55 | setattr(self, "_{}".format('version'), kwargs.get('version', None)) 56 | setattr(self, "_{}".format('version_url'), kwargs.get('version_url', None)) 57 | 58 | @property 59 | def version(self): 60 | """Gets the version of this ServiceVersion. # noqa: E501 61 | 62 | The human-readable semver version string. # noqa: E501 63 | 64 | :return: The version of this ServiceVersion. # noqa: E501 65 | :rtype: str 66 | """ 67 | return self._version 68 | 69 | @version.setter 70 | def version(self, version): 71 | """Sets the version of this ServiceVersion. 72 | 73 | The human-readable semver version string. # noqa: E501 74 | 75 | :param version: The version of this ServiceVersion. # noqa: E501 76 | :type: str 77 | """ 78 | 79 | self._version = version 80 | 81 | @property 82 | def version_url(self): 83 | """Gets the version_url of this ServiceVersion. # noqa: E501 84 | 85 | The URL where this version of the API can be found. # noqa: E501 86 | 87 | :return: The version_url of this ServiceVersion. # noqa: E501 88 | :rtype: str 89 | """ 90 | return self._version_url 91 | 92 | @version_url.setter 93 | def version_url(self, version_url): 94 | """Sets the version_url of this ServiceVersion. 95 | 96 | The URL where this version of the API can be found. # noqa: E501 97 | 98 | :param version_url: The version_url of this ServiceVersion. # noqa: E501 99 | :type: str 100 | """ 101 | 102 | self._version_url = version_url 103 | 104 | def to_dict(self): 105 | """Returns the model properties as a dict""" 106 | result = {} 107 | 108 | for attr, _ in six.iteritems(self.swagger_types): 109 | value = getattr(self, attr) 110 | if isinstance(value, list): 111 | result[attr] = list(map( 112 | lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 113 | value 114 | )) 115 | elif hasattr(value, "to_dict"): 116 | result[attr] = value.to_dict() 117 | elif isinstance(value, dict): 118 | result[attr] = dict(map( 119 | lambda item: (item[0], item[1].to_dict()) 120 | if hasattr(item[1], "to_dict") else item, 121 | value.items() 122 | )) 123 | else: 124 | result[attr] = value 125 | if issubclass(ServiceVersion, dict): 126 | for key, value in self.items(): 127 | result[key] = value 128 | 129 | return result 130 | 131 | def to_str(self): 132 | """Returns the string representation of the model""" 133 | return pprint.pformat(self.to_dict()) 134 | 135 | def __repr__(self): 136 | """For `print` and `pprint`""" 137 | return self.to_str() 138 | 139 | def __eq__(self, other): 140 | """Returns true if both objects are equal""" 141 | if not isinstance(other, ServiceVersion): 142 | return False 143 | 144 | return self.to_dict() == other.to_dict() 145 | 146 | def __ne__(self, other): 147 | """Returns true if both objects are not equal""" 148 | if not isinstance(other, ServiceVersion): 149 | return True 150 | 151 | return self.to_dict() != other.to_dict() 152 | -------------------------------------------------------------------------------- /docusign_click/models/conversion_document.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | 5 | No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501 6 | 7 | OpenAPI spec version: v1 8 | 9 | Generated by: https://github.com/swagger-api/swagger-codegen.git 10 | """ 11 | 12 | 13 | import pprint 14 | import re # noqa: F401 15 | 16 | import six 17 | 18 | 19 | class ConversionDocument(object): 20 | """NOTE: This class is auto generated by the swagger code generator program. 21 | 22 | Do not edit the class manually. 23 | """ 24 | 25 | """ 26 | Attributes: 27 | swagger_types (dict): The key is attribute name 28 | and the value is attribute type. 29 | attribute_map (dict): The key is attribute name 30 | and the value is json key in definition. 31 | """ 32 | swagger_types = { 33 | 'base64': 'str', 34 | 'file_extension': 'str', 35 | 'file_name': 'str' 36 | } 37 | 38 | attribute_map = { 39 | 'base64': 'base64', 40 | 'file_extension': 'fileExtension', 41 | 'file_name': 'fileName' 42 | } 43 | 44 | def __init__(self, base64=None, file_extension=None, file_name=None): # noqa: E501 45 | """ConversionDocument - a model defined in Swagger""" # noqa: E501 46 | 47 | self._base64 = None 48 | self._file_extension = None 49 | self._file_name = None 50 | self.discriminator = None 51 | 52 | if base64 is not None: 53 | self.base64 = base64 54 | if file_extension is not None: 55 | self.file_extension = file_extension 56 | if file_name is not None: 57 | self.file_name = file_name 58 | 59 | @property 60 | def base64(self): 61 | """Gets the base64 of this ConversionDocument. # noqa: E501 62 | 63 | # noqa: E501 64 | 65 | :return: The base64 of this ConversionDocument. # noqa: E501 66 | :rtype: str 67 | """ 68 | return self._base64 69 | 70 | @base64.setter 71 | def base64(self, base64): 72 | """Sets the base64 of this ConversionDocument. 73 | 74 | # noqa: E501 75 | 76 | :param base64: The base64 of this ConversionDocument. # noqa: E501 77 | :type: str 78 | """ 79 | 80 | self._base64 = base64 81 | 82 | @property 83 | def file_extension(self): 84 | """Gets the file_extension of this ConversionDocument. # noqa: E501 85 | 86 | # noqa: E501 87 | 88 | :return: The file_extension of this ConversionDocument. # noqa: E501 89 | :rtype: str 90 | """ 91 | return self._file_extension 92 | 93 | @file_extension.setter 94 | def file_extension(self, file_extension): 95 | """Sets the file_extension of this ConversionDocument. 96 | 97 | # noqa: E501 98 | 99 | :param file_extension: The file_extension of this ConversionDocument. # noqa: E501 100 | :type: str 101 | """ 102 | 103 | self._file_extension = file_extension 104 | 105 | @property 106 | def file_name(self): 107 | """Gets the file_name of this ConversionDocument. # noqa: E501 108 | 109 | # noqa: E501 110 | 111 | :return: The file_name of this ConversionDocument. # noqa: E501 112 | :rtype: str 113 | """ 114 | return self._file_name 115 | 116 | @file_name.setter 117 | def file_name(self, file_name): 118 | """Sets the file_name of this ConversionDocument. 119 | 120 | # noqa: E501 121 | 122 | :param file_name: The file_name of this ConversionDocument. # noqa: E501 123 | :type: str 124 | """ 125 | 126 | self._file_name = file_name 127 | 128 | def to_dict(self): 129 | """Returns the model properties as a dict""" 130 | result = {} 131 | 132 | for attr, _ in six.iteritems(self.swagger_types): 133 | value = getattr(self, attr) 134 | if isinstance(value, list): 135 | result[attr] = list(map( 136 | lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 137 | value 138 | )) 139 | elif hasattr(value, "to_dict"): 140 | result[attr] = value.to_dict() 141 | elif isinstance(value, dict): 142 | result[attr] = dict(map( 143 | lambda item: (item[0], item[1].to_dict()) 144 | if hasattr(item[1], "to_dict") else item, 145 | value.items() 146 | )) 147 | else: 148 | result[attr] = value 149 | if issubclass(ConversionDocument, dict): 150 | for key, value in self.items(): 151 | result[key] = value 152 | 153 | return result 154 | 155 | def to_str(self): 156 | """Returns the string representation of the model""" 157 | return pprint.pformat(self.to_dict()) 158 | 159 | def __repr__(self): 160 | """For `print` and `pprint`""" 161 | return self.to_str() 162 | 163 | def __eq__(self, other): 164 | """Returns true if both objects are equal""" 165 | if not isinstance(other, ConversionDocument): 166 | return False 167 | 168 | return self.__dict__ == other.__dict__ 169 | 170 | def __ne__(self, other): 171 | """Returns true if both objects are not equal""" 172 | return not self == other 173 | -------------------------------------------------------------------------------- /docusign_click/models/data_field.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | DocuSign Click API 5 | 6 | Elastic signing (also known as DocuSign Click) lets you capture consent to standard agreement terms with a single click: terms and conditions, terms of service, terms of use, privacy policies, and more. The Click API lets you include this customizable elastic template solution in your DocuSign integrations. # noqa: E501 7 | 8 | OpenAPI spec version: v1 9 | Contact: devcenter@docusign.com 10 | Generated by: https://github.com/swagger-api/swagger-codegen.git 11 | """ 12 | 13 | 14 | import pprint 15 | import re # noqa: F401 16 | 17 | import six 18 | 19 | from docusign_click.client.configuration import Configuration 20 | 21 | 22 | class DataField(object): 23 | """NOTE: This class is auto generated by the swagger code generator program. 24 | 25 | Do not edit the class manually. 26 | """ 27 | 28 | """ 29 | Attributes: 30 | swagger_types (dict): The key is attribute name 31 | and the value is attribute type. 32 | attribute_map (dict): The key is attribute name 33 | and the value is json key in definition. 34 | """ 35 | swagger_types = { 36 | 'label': 'str', 37 | 'name': 'str', 38 | 'type': 'str' 39 | } 40 | 41 | attribute_map = { 42 | 'label': 'label', 43 | 'name': 'name', 44 | 'type': 'type' 45 | } 46 | 47 | def __init__(self, _configuration=None, **kwargs): # noqa: E501 48 | """DataField - a model defined in Swagger""" # noqa: E501 49 | if _configuration is None: 50 | _configuration = Configuration() 51 | self._configuration = _configuration 52 | 53 | self._label = None 54 | self._name = None 55 | self._type = None 56 | self.discriminator = None 57 | 58 | setattr(self, "_{}".format('label'), kwargs.get('label', None)) 59 | setattr(self, "_{}".format('name'), kwargs.get('name', None)) 60 | setattr(self, "_{}".format('type'), kwargs.get('type', None)) 61 | 62 | @property 63 | def label(self): 64 | """Gets the label of this DataField. # noqa: E501 65 | 66 | # noqa: E501 67 | 68 | :return: The label of this DataField. # noqa: E501 69 | :rtype: str 70 | """ 71 | return self._label 72 | 73 | @label.setter 74 | def label(self, label): 75 | """Sets the label of this DataField. 76 | 77 | # noqa: E501 78 | 79 | :param label: The label of this DataField. # noqa: E501 80 | :type: str 81 | """ 82 | 83 | self._label = label 84 | 85 | @property 86 | def name(self): 87 | """Gets the name of this DataField. # noqa: E501 88 | 89 | # noqa: E501 90 | 91 | :return: The name of this DataField. # noqa: E501 92 | :rtype: str 93 | """ 94 | return self._name 95 | 96 | @name.setter 97 | def name(self, name): 98 | """Sets the name of this DataField. 99 | 100 | # noqa: E501 101 | 102 | :param name: The name of this DataField. # noqa: E501 103 | :type: str 104 | """ 105 | 106 | self._name = name 107 | 108 | @property 109 | def type(self): 110 | """Gets the type of this DataField. # noqa: E501 111 | 112 | # noqa: E501 113 | 114 | :return: The type of this DataField. # noqa: E501 115 | :rtype: str 116 | """ 117 | return self._type 118 | 119 | @type.setter 120 | def type(self, type): 121 | """Sets the type of this DataField. 122 | 123 | # noqa: E501 124 | 125 | :param type: The type of this DataField. # noqa: E501 126 | :type: str 127 | """ 128 | 129 | self._type = type 130 | 131 | def to_dict(self): 132 | """Returns the model properties as a dict""" 133 | result = {} 134 | 135 | for attr, _ in six.iteritems(self.swagger_types): 136 | value = getattr(self, attr) 137 | if isinstance(value, list): 138 | result[attr] = list(map( 139 | lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 140 | value 141 | )) 142 | elif hasattr(value, "to_dict"): 143 | result[attr] = value.to_dict() 144 | elif isinstance(value, dict): 145 | result[attr] = dict(map( 146 | lambda item: (item[0], item[1].to_dict()) 147 | if hasattr(item[1], "to_dict") else item, 148 | value.items() 149 | )) 150 | else: 151 | result[attr] = value 152 | if issubclass(DataField, dict): 153 | for key, value in self.items(): 154 | result[key] = value 155 | 156 | return result 157 | 158 | def to_str(self): 159 | """Returns the string representation of the model""" 160 | return pprint.pformat(self.to_dict()) 161 | 162 | def __repr__(self): 163 | """For `print` and `pprint`""" 164 | return self.to_str() 165 | 166 | def __eq__(self, other): 167 | """Returns true if both objects are equal""" 168 | if not isinstance(other, DataField): 169 | return False 170 | 171 | return self.to_dict() == other.to_dict() 172 | 173 | def __ne__(self, other): 174 | """Returns true if both objects are not equal""" 175 | if not isinstance(other, DataField): 176 | return True 177 | 178 | return self.to_dict() != other.to_dict() 179 | -------------------------------------------------------------------------------- /docusign_click/models/clickwrap_transfer_request.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | DocuSign Click API 5 | 6 | Elastic signing (also known as DocuSign Click) lets you capture consent to standard agreement terms with a single click: terms and conditions, terms of service, terms of use, privacy policies, and more. The Click API lets you include this customizable elastic template solution in your DocuSign integrations. # noqa: E501 7 | 8 | OpenAPI spec version: v1 9 | Contact: devcenter@docusign.com 10 | Generated by: https://github.com/swagger-api/swagger-codegen.git 11 | """ 12 | 13 | 14 | import pprint 15 | import re # noqa: F401 16 | 17 | import six 18 | 19 | from docusign_click.client.configuration import Configuration 20 | 21 | 22 | class ClickwrapTransferRequest(object): 23 | """NOTE: This class is auto generated by the swagger code generator program. 24 | 25 | Do not edit the class manually. 26 | """ 27 | 28 | """ 29 | Attributes: 30 | swagger_types (dict): The key is attribute name 31 | and the value is attribute type. 32 | attribute_map (dict): The key is attribute name 33 | and the value is json key in definition. 34 | """ 35 | swagger_types = { 36 | 'transfer_from_user_id': 'str', 37 | 'transfer_to_user_id': 'str' 38 | } 39 | 40 | attribute_map = { 41 | 'transfer_from_user_id': 'transferFromUserId', 42 | 'transfer_to_user_id': 'transferToUserId' 43 | } 44 | 45 | def __init__(self, _configuration=None, **kwargs): # noqa: E501 46 | """ClickwrapTransferRequest - a model defined in Swagger""" # noqa: E501 47 | if _configuration is None: 48 | _configuration = Configuration() 49 | self._configuration = _configuration 50 | 51 | self._transfer_from_user_id = None 52 | self._transfer_to_user_id = None 53 | self.discriminator = None 54 | 55 | setattr(self, "_{}".format('transfer_from_user_id'), kwargs.get('transfer_from_user_id', None)) 56 | setattr(self, "_{}".format('transfer_to_user_id'), kwargs.get('transfer_to_user_id', None)) 57 | 58 | @property 59 | def transfer_from_user_id(self): 60 | """Gets the transfer_from_user_id of this ClickwrapTransferRequest. # noqa: E501 61 | 62 | ID of the user to transfer from. This property is required. # noqa: E501 63 | 64 | :return: The transfer_from_user_id of this ClickwrapTransferRequest. # noqa: E501 65 | :rtype: str 66 | """ 67 | return self._transfer_from_user_id 68 | 69 | @transfer_from_user_id.setter 70 | def transfer_from_user_id(self, transfer_from_user_id): 71 | """Sets the transfer_from_user_id of this ClickwrapTransferRequest. 72 | 73 | ID of the user to transfer from. This property is required. # noqa: E501 74 | 75 | :param transfer_from_user_id: The transfer_from_user_id of this ClickwrapTransferRequest. # noqa: E501 76 | :type: str 77 | """ 78 | 79 | self._transfer_from_user_id = transfer_from_user_id 80 | 81 | @property 82 | def transfer_to_user_id(self): 83 | """Gets the transfer_to_user_id of this ClickwrapTransferRequest. # noqa: E501 84 | 85 | ID of the user to transfer to. This property is required. # noqa: E501 86 | 87 | :return: The transfer_to_user_id of this ClickwrapTransferRequest. # noqa: E501 88 | :rtype: str 89 | """ 90 | return self._transfer_to_user_id 91 | 92 | @transfer_to_user_id.setter 93 | def transfer_to_user_id(self, transfer_to_user_id): 94 | """Sets the transfer_to_user_id of this ClickwrapTransferRequest. 95 | 96 | ID of the user to transfer to. This property is required. # noqa: E501 97 | 98 | :param transfer_to_user_id: The transfer_to_user_id of this ClickwrapTransferRequest. # noqa: E501 99 | :type: str 100 | """ 101 | 102 | self._transfer_to_user_id = transfer_to_user_id 103 | 104 | def to_dict(self): 105 | """Returns the model properties as a dict""" 106 | result = {} 107 | 108 | for attr, _ in six.iteritems(self.swagger_types): 109 | value = getattr(self, attr) 110 | if isinstance(value, list): 111 | result[attr] = list(map( 112 | lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 113 | value 114 | )) 115 | elif hasattr(value, "to_dict"): 116 | result[attr] = value.to_dict() 117 | elif isinstance(value, dict): 118 | result[attr] = dict(map( 119 | lambda item: (item[0], item[1].to_dict()) 120 | if hasattr(item[1], "to_dict") else item, 121 | value.items() 122 | )) 123 | else: 124 | result[attr] = value 125 | if issubclass(ClickwrapTransferRequest, dict): 126 | for key, value in self.items(): 127 | result[key] = value 128 | 129 | return result 130 | 131 | def to_str(self): 132 | """Returns the string representation of the model""" 133 | return pprint.pformat(self.to_dict()) 134 | 135 | def __repr__(self): 136 | """For `print` and `pprint`""" 137 | return self.to_str() 138 | 139 | def __eq__(self, other): 140 | """Returns true if both objects are equal""" 141 | if not isinstance(other, ClickwrapTransferRequest): 142 | return False 143 | 144 | return self.to_dict() == other.to_dict() 145 | 146 | def __ne__(self, other): 147 | """Returns true if both objects are not equal""" 148 | if not isinstance(other, ClickwrapTransferRequest): 149 | return True 150 | 151 | return self.to_dict() != other.to_dict() 152 | -------------------------------------------------------------------------------- /docusign_click/models/bulk_clickwrap_request.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | DocuSign Click API 5 | 6 | Elastic signing (also known as DocuSign Click) lets you capture consent to standard agreement terms with a single click: terms and conditions, terms of service, terms of use, privacy policies, and more. The Click API lets you include this customizable elastic template solution in your DocuSign integrations. # noqa: E501 7 | 8 | OpenAPI spec version: v1 9 | Contact: devcenter@docusign.com 10 | Generated by: https://github.com/swagger-api/swagger-codegen.git 11 | """ 12 | 13 | 14 | import pprint 15 | import re # noqa: F401 16 | 17 | import six 18 | 19 | from docusign_click.client.configuration import Configuration 20 | 21 | 22 | class BulkClickwrapRequest(object): 23 | """NOTE: This class is auto generated by the swagger code generator program. 24 | 25 | Do not edit the class manually. 26 | """ 27 | 28 | """ 29 | Attributes: 30 | swagger_types (dict): The key is attribute name 31 | and the value is attribute type. 32 | attribute_map (dict): The key is attribute name 33 | and the value is json key in definition. 34 | """ 35 | swagger_types = { 36 | 'from_date': 'object', 37 | 'status': 'str', 38 | 'to_date': 'object' 39 | } 40 | 41 | attribute_map = { 42 | 'from_date': 'fromDate', 43 | 'status': 'status', 44 | 'to_date': 'toDate' 45 | } 46 | 47 | def __init__(self, _configuration=None, **kwargs): # noqa: E501 48 | """BulkClickwrapRequest - a model defined in Swagger""" # noqa: E501 49 | if _configuration is None: 50 | _configuration = Configuration() 51 | self._configuration = _configuration 52 | 53 | self._from_date = None 54 | self._status = None 55 | self._to_date = None 56 | self.discriminator = None 57 | 58 | setattr(self, "_{}".format('from_date'), kwargs.get('from_date', None)) 59 | setattr(self, "_{}".format('status'), kwargs.get('status', None)) 60 | setattr(self, "_{}".format('to_date'), kwargs.get('to_date', None)) 61 | 62 | @property 63 | def from_date(self): 64 | """Gets the from_date of this BulkClickwrapRequest. # noqa: E501 65 | 66 | The earliest date to return agreements from. # noqa: E501 67 | 68 | :return: The from_date of this BulkClickwrapRequest. # noqa: E501 69 | :rtype: object 70 | """ 71 | return self._from_date 72 | 73 | @from_date.setter 74 | def from_date(self, from_date): 75 | """Sets the from_date of this BulkClickwrapRequest. 76 | 77 | The earliest date to return agreements from. # noqa: E501 78 | 79 | :param from_date: The from_date of this BulkClickwrapRequest. # noqa: E501 80 | :type: object 81 | """ 82 | 83 | self._from_date = from_date 84 | 85 | @property 86 | def status(self): 87 | """Gets the status of this BulkClickwrapRequest. # noqa: E501 88 | 89 | User agreement status. One of: - `agreed` - `declined` # noqa: E501 90 | 91 | :return: The status of this BulkClickwrapRequest. # noqa: E501 92 | :rtype: str 93 | """ 94 | return self._status 95 | 96 | @status.setter 97 | def status(self, status): 98 | """Sets the status of this BulkClickwrapRequest. 99 | 100 | User agreement status. One of: - `agreed` - `declined` # noqa: E501 101 | 102 | :param status: The status of this BulkClickwrapRequest. # noqa: E501 103 | :type: str 104 | """ 105 | 106 | self._status = status 107 | 108 | @property 109 | def to_date(self): 110 | """Gets the to_date of this BulkClickwrapRequest. # noqa: E501 111 | 112 | The latest date to return agreements from. # noqa: E501 113 | 114 | :return: The to_date of this BulkClickwrapRequest. # noqa: E501 115 | :rtype: object 116 | """ 117 | return self._to_date 118 | 119 | @to_date.setter 120 | def to_date(self, to_date): 121 | """Sets the to_date of this BulkClickwrapRequest. 122 | 123 | The latest date to return agreements from. # noqa: E501 124 | 125 | :param to_date: The to_date of this BulkClickwrapRequest. # noqa: E501 126 | :type: object 127 | """ 128 | 129 | self._to_date = to_date 130 | 131 | def to_dict(self): 132 | """Returns the model properties as a dict""" 133 | result = {} 134 | 135 | for attr, _ in six.iteritems(self.swagger_types): 136 | value = getattr(self, attr) 137 | if isinstance(value, list): 138 | result[attr] = list(map( 139 | lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 140 | value 141 | )) 142 | elif hasattr(value, "to_dict"): 143 | result[attr] = value.to_dict() 144 | elif isinstance(value, dict): 145 | result[attr] = dict(map( 146 | lambda item: (item[0], item[1].to_dict()) 147 | if hasattr(item[1], "to_dict") else item, 148 | value.items() 149 | )) 150 | else: 151 | result[attr] = value 152 | if issubclass(BulkClickwrapRequest, dict): 153 | for key, value in self.items(): 154 | result[key] = value 155 | 156 | return result 157 | 158 | def to_str(self): 159 | """Returns the string representation of the model""" 160 | return pprint.pformat(self.to_dict()) 161 | 162 | def __repr__(self): 163 | """For `print` and `pprint`""" 164 | return self.to_str() 165 | 166 | def __eq__(self, other): 167 | """Returns true if both objects are equal""" 168 | if not isinstance(other, BulkClickwrapRequest): 169 | return False 170 | 171 | return self.to_dict() == other.to_dict() 172 | 173 | def __ne__(self, other): 174 | """Returns true if both objects are not equal""" 175 | if not isinstance(other, BulkClickwrapRequest): 176 | return True 177 | 178 | return self.to_dict() != other.to_dict() 179 | -------------------------------------------------------------------------------- /docusign_click/models/clickwraps_response.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | 5 | No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501 6 | 7 | OpenAPI spec version: v1 8 | 9 | Generated by: https://github.com/swagger-api/swagger-codegen.git 10 | """ 11 | 12 | 13 | import pprint 14 | import re # noqa: F401 15 | 16 | import six 17 | 18 | 19 | class ClickwrapsResponse(object): 20 | """NOTE: This class is auto generated by the swagger code generator program. 21 | 22 | Do not edit the class manually. 23 | """ 24 | 25 | """ 26 | Attributes: 27 | swagger_types (dict): The key is attribute name 28 | and the value is attribute type. 29 | attribute_map (dict): The key is attribute name 30 | and the value is json key in definition. 31 | """ 32 | swagger_types = { 33 | 'clickwraps': 'list[ClickwrapSummaryResponse]', 34 | 'minimum_pages_remaining': 'int', 35 | 'page': 'int', 36 | 'page_size': 'int' 37 | } 38 | 39 | attribute_map = { 40 | 'clickwraps': 'clickwraps', 41 | 'minimum_pages_remaining': 'minimumPagesRemaining', 42 | 'page': 'page', 43 | 'page_size': 'pageSize' 44 | } 45 | 46 | def __init__(self, clickwraps=None, minimum_pages_remaining=None, page=None, page_size=None): # noqa: E501 47 | """ClickwrapsResponse - a model defined in Swagger""" # noqa: E501 48 | 49 | self._clickwraps = None 50 | self._minimum_pages_remaining = None 51 | self._page = None 52 | self._page_size = None 53 | self.discriminator = None 54 | 55 | if clickwraps is not None: 56 | self.clickwraps = clickwraps 57 | if minimum_pages_remaining is not None: 58 | self.minimum_pages_remaining = minimum_pages_remaining 59 | if page is not None: 60 | self.page = page 61 | if page_size is not None: 62 | self.page_size = page_size 63 | 64 | @property 65 | def clickwraps(self): 66 | """Gets the clickwraps of this ClickwrapsResponse. # noqa: E501 67 | 68 | # noqa: E501 69 | 70 | :return: The clickwraps of this ClickwrapsResponse. # noqa: E501 71 | :rtype: list[ClickwrapSummaryResponse] 72 | """ 73 | return self._clickwraps 74 | 75 | @clickwraps.setter 76 | def clickwraps(self, clickwraps): 77 | """Sets the clickwraps of this ClickwrapsResponse. 78 | 79 | # noqa: E501 80 | 81 | :param clickwraps: The clickwraps of this ClickwrapsResponse. # noqa: E501 82 | :type: list[ClickwrapSummaryResponse] 83 | """ 84 | 85 | self._clickwraps = clickwraps 86 | 87 | @property 88 | def minimum_pages_remaining(self): 89 | """Gets the minimum_pages_remaining of this ClickwrapsResponse. # noqa: E501 90 | 91 | # noqa: E501 92 | 93 | :return: The minimum_pages_remaining of this ClickwrapsResponse. # noqa: E501 94 | :rtype: int 95 | """ 96 | return self._minimum_pages_remaining 97 | 98 | @minimum_pages_remaining.setter 99 | def minimum_pages_remaining(self, minimum_pages_remaining): 100 | """Sets the minimum_pages_remaining of this ClickwrapsResponse. 101 | 102 | # noqa: E501 103 | 104 | :param minimum_pages_remaining: The minimum_pages_remaining of this ClickwrapsResponse. # noqa: E501 105 | :type: int 106 | """ 107 | 108 | self._minimum_pages_remaining = minimum_pages_remaining 109 | 110 | @property 111 | def page(self): 112 | """Gets the page of this ClickwrapsResponse. # noqa: E501 113 | 114 | # noqa: E501 115 | 116 | :return: The page of this ClickwrapsResponse. # noqa: E501 117 | :rtype: int 118 | """ 119 | return self._page 120 | 121 | @page.setter 122 | def page(self, page): 123 | """Sets the page of this ClickwrapsResponse. 124 | 125 | # noqa: E501 126 | 127 | :param page: The page of this ClickwrapsResponse. # noqa: E501 128 | :type: int 129 | """ 130 | 131 | self._page = page 132 | 133 | @property 134 | def page_size(self): 135 | """Gets the page_size of this ClickwrapsResponse. # noqa: E501 136 | 137 | # noqa: E501 138 | 139 | :return: The page_size of this ClickwrapsResponse. # noqa: E501 140 | :rtype: int 141 | """ 142 | return self._page_size 143 | 144 | @page_size.setter 145 | def page_size(self, page_size): 146 | """Sets the page_size of this ClickwrapsResponse. 147 | 148 | # noqa: E501 149 | 150 | :param page_size: The page_size of this ClickwrapsResponse. # noqa: E501 151 | :type: int 152 | """ 153 | 154 | self._page_size = page_size 155 | 156 | def to_dict(self): 157 | """Returns the model properties as a dict""" 158 | result = {} 159 | 160 | for attr, _ in six.iteritems(self.swagger_types): 161 | value = getattr(self, attr) 162 | if isinstance(value, list): 163 | result[attr] = list(map( 164 | lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 165 | value 166 | )) 167 | elif hasattr(value, "to_dict"): 168 | result[attr] = value.to_dict() 169 | elif isinstance(value, dict): 170 | result[attr] = dict(map( 171 | lambda item: (item[0], item[1].to_dict()) 172 | if hasattr(item[1], "to_dict") else item, 173 | value.items() 174 | )) 175 | else: 176 | result[attr] = value 177 | if issubclass(ClickwrapsResponse, dict): 178 | for key, value in self.items(): 179 | result[key] = value 180 | 181 | return result 182 | 183 | def to_str(self): 184 | """Returns the string representation of the model""" 185 | return pprint.pformat(self.to_dict()) 186 | 187 | def __repr__(self): 188 | """For `print` and `pprint`""" 189 | return self.to_str() 190 | 191 | def __eq__(self, other): 192 | """Returns true if both objects are equal""" 193 | if not isinstance(other, ClickwrapsResponse): 194 | return False 195 | 196 | return self.__dict__ == other.__dict__ 197 | 198 | def __ne__(self, other): 199 | """Returns true if both objects are not equal""" 200 | return not self == other 201 | -------------------------------------------------------------------------------- /docusign_click/models/clickwrap_versions_delete_response.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | DocuSign Click API 5 | 6 | Elastic signing (also known as DocuSign Click) lets you capture consent to standard agreement terms with a single click: terms and conditions, terms of service, terms of use, privacy policies, and more. The Click API lets you include this customizable elastic template solution in your DocuSign integrations. # noqa: E501 7 | 8 | OpenAPI spec version: v1 9 | Contact: devcenter@docusign.com 10 | Generated by: https://github.com/swagger-api/swagger-codegen.git 11 | """ 12 | 13 | 14 | import pprint 15 | import re # noqa: F401 16 | 17 | import six 18 | 19 | from docusign_click.client.configuration import Configuration 20 | 21 | 22 | class ClickwrapVersionsDeleteResponse(object): 23 | """NOTE: This class is auto generated by the swagger code generator program. 24 | 25 | Do not edit the class manually. 26 | """ 27 | 28 | """ 29 | Attributes: 30 | swagger_types (dict): The key is attribute name 31 | and the value is attribute type. 32 | attribute_map (dict): The key is attribute name 33 | and the value is json key in definition. 34 | """ 35 | swagger_types = { 36 | 'clickwrap_id': 'str', 37 | 'clickwrap_name': 'str', 38 | 'versions': 'list[ClickwrapVersionDeleteResponse]' 39 | } 40 | 41 | attribute_map = { 42 | 'clickwrap_id': 'clickwrapId', 43 | 'clickwrap_name': 'clickwrapName', 44 | 'versions': 'versions' 45 | } 46 | 47 | def __init__(self, _configuration=None, **kwargs): # noqa: E501 48 | """ClickwrapVersionsDeleteResponse - a model defined in Swagger""" # noqa: E501 49 | if _configuration is None: 50 | _configuration = Configuration() 51 | self._configuration = _configuration 52 | 53 | self._clickwrap_id = None 54 | self._clickwrap_name = None 55 | self._versions = None 56 | self.discriminator = None 57 | 58 | setattr(self, "_{}".format('clickwrap_id'), kwargs.get('clickwrap_id', None)) 59 | setattr(self, "_{}".format('clickwrap_name'), kwargs.get('clickwrap_name', None)) 60 | setattr(self, "_{}".format('versions'), kwargs.get('versions', None)) 61 | 62 | @property 63 | def clickwrap_id(self): 64 | """Gets the clickwrap_id of this ClickwrapVersionsDeleteResponse. # noqa: E501 65 | 66 | The ID of the clickwrap. # noqa: E501 67 | 68 | :return: The clickwrap_id of this ClickwrapVersionsDeleteResponse. # noqa: E501 69 | :rtype: str 70 | """ 71 | return self._clickwrap_id 72 | 73 | @clickwrap_id.setter 74 | def clickwrap_id(self, clickwrap_id): 75 | """Sets the clickwrap_id of this ClickwrapVersionsDeleteResponse. 76 | 77 | The ID of the clickwrap. # noqa: E501 78 | 79 | :param clickwrap_id: The clickwrap_id of this ClickwrapVersionsDeleteResponse. # noqa: E501 80 | :type: str 81 | """ 82 | 83 | self._clickwrap_id = clickwrap_id 84 | 85 | @property 86 | def clickwrap_name(self): 87 | """Gets the clickwrap_name of this ClickwrapVersionsDeleteResponse. # noqa: E501 88 | 89 | The name of the clickwrap. # noqa: E501 90 | 91 | :return: The clickwrap_name of this ClickwrapVersionsDeleteResponse. # noqa: E501 92 | :rtype: str 93 | """ 94 | return self._clickwrap_name 95 | 96 | @clickwrap_name.setter 97 | def clickwrap_name(self, clickwrap_name): 98 | """Sets the clickwrap_name of this ClickwrapVersionsDeleteResponse. 99 | 100 | The name of the clickwrap. # noqa: E501 101 | 102 | :param clickwrap_name: The clickwrap_name of this ClickwrapVersionsDeleteResponse. # noqa: E501 103 | :type: str 104 | """ 105 | 106 | self._clickwrap_name = clickwrap_name 107 | 108 | @property 109 | def versions(self): 110 | """Gets the versions of this ClickwrapVersionsDeleteResponse. # noqa: E501 111 | 112 | An array of delete responses. # noqa: E501 113 | 114 | :return: The versions of this ClickwrapVersionsDeleteResponse. # noqa: E501 115 | :rtype: list[ClickwrapVersionDeleteResponse] 116 | """ 117 | return self._versions 118 | 119 | @versions.setter 120 | def versions(self, versions): 121 | """Sets the versions of this ClickwrapVersionsDeleteResponse. 122 | 123 | An array of delete responses. # noqa: E501 124 | 125 | :param versions: The versions of this ClickwrapVersionsDeleteResponse. # noqa: E501 126 | :type: list[ClickwrapVersionDeleteResponse] 127 | """ 128 | 129 | self._versions = versions 130 | 131 | def to_dict(self): 132 | """Returns the model properties as a dict""" 133 | result = {} 134 | 135 | for attr, _ in six.iteritems(self.swagger_types): 136 | value = getattr(self, attr) 137 | if isinstance(value, list): 138 | result[attr] = list(map( 139 | lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 140 | value 141 | )) 142 | elif hasattr(value, "to_dict"): 143 | result[attr] = value.to_dict() 144 | elif isinstance(value, dict): 145 | result[attr] = dict(map( 146 | lambda item: (item[0], item[1].to_dict()) 147 | if hasattr(item[1], "to_dict") else item, 148 | value.items() 149 | )) 150 | else: 151 | result[attr] = value 152 | if issubclass(ClickwrapVersionsDeleteResponse, dict): 153 | for key, value in self.items(): 154 | result[key] = value 155 | 156 | return result 157 | 158 | def to_str(self): 159 | """Returns the string representation of the model""" 160 | return pprint.pformat(self.to_dict()) 161 | 162 | def __repr__(self): 163 | """For `print` and `pprint`""" 164 | return self.to_str() 165 | 166 | def __eq__(self, other): 167 | """Returns true if both objects are equal""" 168 | if not isinstance(other, ClickwrapVersionsDeleteResponse): 169 | return False 170 | 171 | return self.to_dict() == other.to_dict() 172 | 173 | def __ne__(self, other): 174 | """Returns true if both objects are not equal""" 175 | if not isinstance(other, ClickwrapVersionsDeleteResponse): 176 | return True 177 | 178 | return self.to_dict() != other.to_dict() 179 | -------------------------------------------------------------------------------- /docusign_click/models/clickwrap_scheduled_reacceptance.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | DocuSign Click API 5 | 6 | Elastic signing (also known as DocuSign Click) lets you capture consent to standard agreement terms with a single click: terms and conditions, terms of service, terms of use, privacy policies, and more. The Click API lets you include this customizable elastic template solution in your DocuSign integrations. # noqa: E501 7 | 8 | OpenAPI spec version: v1 9 | Contact: devcenter@docusign.com 10 | Generated by: https://github.com/swagger-api/swagger-codegen.git 11 | """ 12 | 13 | 14 | import pprint 15 | import re # noqa: F401 16 | 17 | import six 18 | 19 | from docusign_click.client.configuration import Configuration 20 | 21 | 22 | class ClickwrapScheduledReacceptance(object): 23 | """NOTE: This class is auto generated by the swagger code generator program. 24 | 25 | Do not edit the class manually. 26 | """ 27 | 28 | """ 29 | Attributes: 30 | swagger_types (dict): The key is attribute name 31 | and the value is attribute type. 32 | attribute_map (dict): The key is attribute name 33 | and the value is json key in definition. 34 | """ 35 | swagger_types = { 36 | 'recurrence_interval': 'int', 37 | 'recurrence_interval_type': 'str', 38 | 'start_date_time': 'object' 39 | } 40 | 41 | attribute_map = { 42 | 'recurrence_interval': 'recurrenceInterval', 43 | 'recurrence_interval_type': 'recurrenceIntervalType', 44 | 'start_date_time': 'startDateTime' 45 | } 46 | 47 | def __init__(self, _configuration=None, **kwargs): # noqa: E501 48 | """ClickwrapScheduledReacceptance - a model defined in Swagger""" # noqa: E501 49 | if _configuration is None: 50 | _configuration = Configuration() 51 | self._configuration = _configuration 52 | 53 | self._recurrence_interval = None 54 | self._recurrence_interval_type = None 55 | self._start_date_time = None 56 | self.discriminator = None 57 | 58 | setattr(self, "_{}".format('recurrence_interval'), kwargs.get('recurrence_interval', None)) 59 | setattr(self, "_{}".format('recurrence_interval_type'), kwargs.get('recurrence_interval_type', None)) 60 | setattr(self, "_{}".format('start_date_time'), kwargs.get('start_date_time', None)) 61 | 62 | @property 63 | def recurrence_interval(self): 64 | """Gets the recurrence_interval of this ClickwrapScheduledReacceptance. # noqa: E501 65 | 66 | The time between recurrences specified in `recurrenceIntervalType` units. The minimum and maximum values depend on `recurrenceIntervalType`: - `days`: 1 - 365 - `weeks`: 1 - 52 - `months`: 1 - 12 - `years`: 1 # noqa: E501 67 | 68 | :return: The recurrence_interval of this ClickwrapScheduledReacceptance. # noqa: E501 69 | :rtype: int 70 | """ 71 | return self._recurrence_interval 72 | 73 | @recurrence_interval.setter 74 | def recurrence_interval(self, recurrence_interval): 75 | """Sets the recurrence_interval of this ClickwrapScheduledReacceptance. 76 | 77 | The time between recurrences specified in `recurrenceIntervalType` units. The minimum and maximum values depend on `recurrenceIntervalType`: - `days`: 1 - 365 - `weeks`: 1 - 52 - `months`: 1 - 12 - `years`: 1 # noqa: E501 78 | 79 | :param recurrence_interval: The recurrence_interval of this ClickwrapScheduledReacceptance. # noqa: E501 80 | :type: int 81 | """ 82 | 83 | self._recurrence_interval = recurrence_interval 84 | 85 | @property 86 | def recurrence_interval_type(self): 87 | """Gets the recurrence_interval_type of this ClickwrapScheduledReacceptance. # noqa: E501 88 | 89 | The units of the `recurrenceInterval`. Must be one of: - `days` - `weeks` - `month` - `years` # noqa: E501 90 | 91 | :return: The recurrence_interval_type of this ClickwrapScheduledReacceptance. # noqa: E501 92 | :rtype: str 93 | """ 94 | return self._recurrence_interval_type 95 | 96 | @recurrence_interval_type.setter 97 | def recurrence_interval_type(self, recurrence_interval_type): 98 | """Sets the recurrence_interval_type of this ClickwrapScheduledReacceptance. 99 | 100 | The units of the `recurrenceInterval`. Must be one of: - `days` - `weeks` - `month` - `years` # noqa: E501 101 | 102 | :param recurrence_interval_type: The recurrence_interval_type of this ClickwrapScheduledReacceptance. # noqa: E501 103 | :type: str 104 | """ 105 | 106 | self._recurrence_interval_type = recurrence_interval_type 107 | 108 | @property 109 | def start_date_time(self): 110 | """Gets the start_date_time of this ClickwrapScheduledReacceptance. # noqa: E501 111 | 112 | The date when the recurrence interval starts. # noqa: E501 113 | 114 | :return: The start_date_time of this ClickwrapScheduledReacceptance. # noqa: E501 115 | :rtype: object 116 | """ 117 | return self._start_date_time 118 | 119 | @start_date_time.setter 120 | def start_date_time(self, start_date_time): 121 | """Sets the start_date_time of this ClickwrapScheduledReacceptance. 122 | 123 | The date when the recurrence interval starts. # noqa: E501 124 | 125 | :param start_date_time: The start_date_time of this ClickwrapScheduledReacceptance. # noqa: E501 126 | :type: object 127 | """ 128 | 129 | self._start_date_time = start_date_time 130 | 131 | def to_dict(self): 132 | """Returns the model properties as a dict""" 133 | result = {} 134 | 135 | for attr, _ in six.iteritems(self.swagger_types): 136 | value = getattr(self, attr) 137 | if isinstance(value, list): 138 | result[attr] = list(map( 139 | lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 140 | value 141 | )) 142 | elif hasattr(value, "to_dict"): 143 | result[attr] = value.to_dict() 144 | elif isinstance(value, dict): 145 | result[attr] = dict(map( 146 | lambda item: (item[0], item[1].to_dict()) 147 | if hasattr(item[1], "to_dict") else item, 148 | value.items() 149 | )) 150 | else: 151 | result[attr] = value 152 | if issubclass(ClickwrapScheduledReacceptance, dict): 153 | for key, value in self.items(): 154 | result[key] = value 155 | 156 | return result 157 | 158 | def to_str(self): 159 | """Returns the string representation of the model""" 160 | return pprint.pformat(self.to_dict()) 161 | 162 | def __repr__(self): 163 | """For `print` and `pprint`""" 164 | return self.to_str() 165 | 166 | def __eq__(self, other): 167 | """Returns true if both objects are equal""" 168 | if not isinstance(other, ClickwrapScheduledReacceptance): 169 | return False 170 | 171 | return self.to_dict() == other.to_dict() 172 | 173 | def __ne__(self, other): 174 | """Returns true if both objects are not equal""" 175 | if not isinstance(other, ClickwrapScheduledReacceptance): 176 | return True 177 | 178 | return self.to_dict() != other.to_dict() 179 | -------------------------------------------------------------------------------- /docusign_click/models/clickwrap_versions_response.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | DocuSign Click API 5 | 6 | Elastic signing (also known as DocuSign Click) lets you capture consent to standard agreement terms with a single click: terms and conditions, terms of service, terms of use, privacy policies, and more. The Click API lets you include this customizable elastic template solution in your DocuSign integrations. # noqa: E501 7 | 8 | OpenAPI spec version: v1 9 | Contact: devcenter@docusign.com 10 | Generated by: https://github.com/swagger-api/swagger-codegen.git 11 | """ 12 | 13 | 14 | import pprint 15 | import re # noqa: F401 16 | 17 | import six 18 | 19 | from docusign_click.client.configuration import Configuration 20 | 21 | 22 | class ClickwrapVersionsResponse(object): 23 | """NOTE: This class is auto generated by the swagger code generator program. 24 | 25 | Do not edit the class manually. 26 | """ 27 | 28 | """ 29 | Attributes: 30 | swagger_types (dict): The key is attribute name 31 | and the value is attribute type. 32 | attribute_map (dict): The key is attribute name 33 | and the value is json key in definition. 34 | """ 35 | swagger_types = { 36 | 'clickwraps': 'list[ClickwrapVersionSummaryResponse]', 37 | 'minimum_pages_remaining': 'int', 38 | 'page': 'int', 39 | 'page_size': 'int' 40 | } 41 | 42 | attribute_map = { 43 | 'clickwraps': 'clickwraps', 44 | 'minimum_pages_remaining': 'minimumPagesRemaining', 45 | 'page': 'page', 46 | 'page_size': 'pageSize' 47 | } 48 | 49 | def __init__(self, _configuration=None, **kwargs): # noqa: E501 50 | """ClickwrapVersionsResponse - a model defined in Swagger""" # noqa: E501 51 | if _configuration is None: 52 | _configuration = Configuration() 53 | self._configuration = _configuration 54 | 55 | self._clickwraps = None 56 | self._minimum_pages_remaining = None 57 | self._page = None 58 | self._page_size = None 59 | self.discriminator = None 60 | 61 | setattr(self, "_{}".format('clickwraps'), kwargs.get('clickwraps', None)) 62 | setattr(self, "_{}".format('minimum_pages_remaining'), kwargs.get('minimum_pages_remaining', None)) 63 | setattr(self, "_{}".format('page'), kwargs.get('page', None)) 64 | setattr(self, "_{}".format('page_size'), kwargs.get('page_size', None)) 65 | 66 | @property 67 | def clickwraps(self): 68 | """Gets the clickwraps of this ClickwrapVersionsResponse. # noqa: E501 69 | 70 | An array of `clickwrapVersionSummaryResponse` objects. # noqa: E501 71 | 72 | :return: The clickwraps of this ClickwrapVersionsResponse. # noqa: E501 73 | :rtype: list[ClickwrapVersionSummaryResponse] 74 | """ 75 | return self._clickwraps 76 | 77 | @clickwraps.setter 78 | def clickwraps(self, clickwraps): 79 | """Sets the clickwraps of this ClickwrapVersionsResponse. 80 | 81 | An array of `clickwrapVersionSummaryResponse` objects. # noqa: E501 82 | 83 | :param clickwraps: The clickwraps of this ClickwrapVersionsResponse. # noqa: E501 84 | :type: list[ClickwrapVersionSummaryResponse] 85 | """ 86 | 87 | self._clickwraps = clickwraps 88 | 89 | @property 90 | def minimum_pages_remaining(self): 91 | """Gets the minimum_pages_remaining of this ClickwrapVersionsResponse. # noqa: E501 92 | 93 | Number of pages remaining in the response. # noqa: E501 94 | 95 | :return: The minimum_pages_remaining of this ClickwrapVersionsResponse. # noqa: E501 96 | :rtype: int 97 | """ 98 | return self._minimum_pages_remaining 99 | 100 | @minimum_pages_remaining.setter 101 | def minimum_pages_remaining(self, minimum_pages_remaining): 102 | """Sets the minimum_pages_remaining of this ClickwrapVersionsResponse. 103 | 104 | Number of pages remaining in the response. # noqa: E501 105 | 106 | :param minimum_pages_remaining: The minimum_pages_remaining of this ClickwrapVersionsResponse. # noqa: E501 107 | :type: int 108 | """ 109 | 110 | self._minimum_pages_remaining = minimum_pages_remaining 111 | 112 | @property 113 | def page(self): 114 | """Gets the page of this ClickwrapVersionsResponse. # noqa: E501 115 | 116 | The number of the current page. # noqa: E501 117 | 118 | :return: The page of this ClickwrapVersionsResponse. # noqa: E501 119 | :rtype: int 120 | """ 121 | return self._page 122 | 123 | @page.setter 124 | def page(self, page): 125 | """Sets the page of this ClickwrapVersionsResponse. 126 | 127 | The number of the current page. # noqa: E501 128 | 129 | :param page: The page of this ClickwrapVersionsResponse. # noqa: E501 130 | :type: int 131 | """ 132 | 133 | self._page = page 134 | 135 | @property 136 | def page_size(self): 137 | """Gets the page_size of this ClickwrapVersionsResponse. # noqa: E501 138 | 139 | The number of items per page. # noqa: E501 140 | 141 | :return: The page_size of this ClickwrapVersionsResponse. # noqa: E501 142 | :rtype: int 143 | """ 144 | return self._page_size 145 | 146 | @page_size.setter 147 | def page_size(self, page_size): 148 | """Sets the page_size of this ClickwrapVersionsResponse. 149 | 150 | The number of items per page. # noqa: E501 151 | 152 | :param page_size: The page_size of this ClickwrapVersionsResponse. # noqa: E501 153 | :type: int 154 | """ 155 | 156 | self._page_size = page_size 157 | 158 | def to_dict(self): 159 | """Returns the model properties as a dict""" 160 | result = {} 161 | 162 | for attr, _ in six.iteritems(self.swagger_types): 163 | value = getattr(self, attr) 164 | if isinstance(value, list): 165 | result[attr] = list(map( 166 | lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 167 | value 168 | )) 169 | elif hasattr(value, "to_dict"): 170 | result[attr] = value.to_dict() 171 | elif isinstance(value, dict): 172 | result[attr] = dict(map( 173 | lambda item: (item[0], item[1].to_dict()) 174 | if hasattr(item[1], "to_dict") else item, 175 | value.items() 176 | )) 177 | else: 178 | result[attr] = value 179 | if issubclass(ClickwrapVersionsResponse, dict): 180 | for key, value in self.items(): 181 | result[key] = value 182 | 183 | return result 184 | 185 | def to_str(self): 186 | """Returns the string representation of the model""" 187 | return pprint.pformat(self.to_dict()) 188 | 189 | def __repr__(self): 190 | """For `print` and `pprint`""" 191 | return self.to_str() 192 | 193 | def __eq__(self, other): 194 | """Returns true if both objects are equal""" 195 | if not isinstance(other, ClickwrapVersionsResponse): 196 | return False 197 | 198 | return self.to_dict() == other.to_dict() 199 | 200 | def __ne__(self, other): 201 | """Returns true if both objects are not equal""" 202 | if not isinstance(other, ClickwrapVersionsResponse): 203 | return True 204 | 205 | return self.to_dict() != other.to_dict() 206 | -------------------------------------------------------------------------------- /docusign_click/client/configuration.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | DocuSign REST API 5 | 6 | The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. 7 | 8 | OpenAPI spec version: v2 9 | Contact: devcenter@docusign.com 10 | Generated by: https://github.com/swagger-api/swagger-codegen.git 11 | """ 12 | 13 | 14 | from __future__ import absolute_import 15 | 16 | import urllib3 17 | 18 | import sys 19 | import logging 20 | 21 | from six import iteritems, PY3 22 | from six.moves import http_client as httplib 23 | 24 | 25 | def singleton(cls, *args, **kw): 26 | instances = {} 27 | 28 | def _singleton(): 29 | if cls not in instances: 30 | instances[cls] = cls(*args, **kw) 31 | return instances[cls] 32 | return _singleton 33 | 34 | 35 | @singleton 36 | class Configuration(object): 37 | """ 38 | NOTE: This class is auto generated by the swagger code generator program. 39 | Ref: https://github.com/swagger-api/swagger-codegen 40 | Do not edit the class manually. 41 | """ 42 | 43 | def __init__(self): 44 | """ 45 | Constructor 46 | """ 47 | # Default Base url 48 | self.host = "https://click.docusign.com/restapi" 49 | # Default api client 50 | self.api_client = None 51 | # Temp file folder for downloading files 52 | self.temp_folder_path = None 53 | 54 | # Authentication Settings 55 | # dict to store API key(s) 56 | self.api_key = {} 57 | # dict to store API prefix (e.g. Bearer) 58 | self.api_key_prefix = {} 59 | # Username for HTTP basic authentication 60 | self.username = "" 61 | # Password for HTTP basic authentication 62 | self.password = "" 63 | 64 | # access token for OAuth 65 | self.access_token = "" 66 | 67 | # Logging Settings 68 | self.logger = {} 69 | self.logger["package_logger"] = logging.getLogger("docusign_click") 70 | self.logger["urllib3_logger"] = logging.getLogger("urllib3") 71 | # Log format 72 | self.logger_format = '%(asctime)s %(levelname)s %(message)s' 73 | # Log stream handler 74 | self.logger_stream_handler = None 75 | # Log file handler 76 | self.logger_file_handler = None 77 | # Debug file location 78 | self.logger_file = None 79 | # Debug switch 80 | self.debug = False 81 | 82 | # SSL/TLS verification 83 | # Set this to false to skip verifying SSL certificate when calling API from https server. 84 | self.verify_ssl = True 85 | # Set this to customize the certificate file to verify the peer. 86 | self.ssl_ca_cert = None 87 | # client certificate file 88 | self.cert_file = None 89 | # client key file 90 | self.key_file = None 91 | 92 | if PY3: 93 | self.user_agent = 'Swagger-Codegen/v1/1.1.0rc1/python3' 94 | else: 95 | self.user_agent = 'Swagger-Codegen/v1/1.1.0rc1/python2' 96 | 97 | @property 98 | def logger_file(self): 99 | """ 100 | Gets the logger_file. 101 | """ 102 | return self.__logger_file 103 | 104 | @logger_file.setter 105 | def logger_file(self, value): 106 | """ 107 | Sets the logger_file. 108 | 109 | If the logger_file is None, then add stream handler and remove file handler. 110 | Otherwise, add file handler and remove stream handler. 111 | 112 | :param value: The logger_file path. 113 | :type: str 114 | """ 115 | self.__logger_file = value 116 | if self.__logger_file: 117 | # If set logging file, 118 | # then add file handler and remove stream handler. 119 | self.logger_file_handler = logging.FileHandler(self.__logger_file) 120 | self.logger_file_handler.setFormatter(self.logger_formatter) 121 | for _, logger in iteritems(self.logger): 122 | logger.addHandler(self.logger_file_handler) 123 | if self.logger_stream_handler: 124 | logger.removeHandler(self.logger_stream_handler) 125 | else: 126 | # If not set logging file, 127 | # then add stream handler and remove file handler. 128 | self.logger_stream_handler = logging.StreamHandler() 129 | self.logger_stream_handler.setFormatter(self.logger_formatter) 130 | for _, logger in iteritems(self.logger): 131 | logger.addHandler(self.logger_stream_handler) 132 | if self.logger_file_handler: 133 | logger.removeHandler(self.logger_file_handler) 134 | 135 | @property 136 | def debug(self): 137 | """ 138 | Gets the debug status. 139 | """ 140 | return self.__debug 141 | 142 | @debug.setter 143 | def debug(self, value): 144 | """ 145 | Sets the debug status. 146 | 147 | :param value: The debug status, True or False. 148 | :type: bool 149 | """ 150 | self.__debug = value 151 | if self.__debug: 152 | # if debug status is True, turn on debug logging 153 | for _, logger in iteritems(self.logger): 154 | logger.setLevel(logging.DEBUG) 155 | # turn on httplib debug 156 | httplib.HTTPConnection.debuglevel = 1 157 | else: 158 | # if debug status is False, turn off debug logging, 159 | # setting log level to default `logging.WARNING` 160 | for _, logger in iteritems(self.logger): 161 | logger.setLevel(logging.WARNING) 162 | # turn off httplib debug 163 | httplib.HTTPConnection.debuglevel = 0 164 | 165 | @property 166 | def logger_format(self): 167 | """ 168 | Gets the logger_format. 169 | """ 170 | return self.__logger_format 171 | 172 | @logger_format.setter 173 | def logger_format(self, value): 174 | """ 175 | Sets the logger_format. 176 | 177 | The logger_formatter will be updated when sets logger_format. 178 | 179 | :param value: The format string. 180 | :type: str 181 | """ 182 | self.__logger_format = value 183 | self.logger_formatter = logging.Formatter(self.__logger_format) 184 | 185 | def get_api_key_with_prefix(self, identifier): 186 | """ 187 | Gets API key (with prefix if set). 188 | 189 | :param identifier: The identifier of apiKey. 190 | :return: The token for api key authentication. 191 | """ 192 | if self.api_key.get(identifier) and self.api_key_prefix.get(identifier): 193 | return self.api_key_prefix[identifier] + ' ' + self.api_key[identifier] 194 | elif self.api_key.get(identifier): 195 | return self.api_key[identifier] 196 | 197 | def get_basic_auth_token(self): 198 | """ 199 | Gets HTTP basic authentication header (string). 200 | 201 | :return: The token for basic HTTP authentication. 202 | """ 203 | return urllib3.util.make_headers(basic_auth=self.username + ':' + self.password)\ 204 | .get('authorization') 205 | 206 | def auth_settings(self): 207 | """ 208 | Gets Auth Settings dict for api client. 209 | 210 | :return: The Auth Settings information dict. 211 | """ 212 | return { 213 | 214 | 'docusignAccessCode': 215 | { 216 | 'type': 'oauth2', 217 | 'in': 'header', 218 | 'key': 'Authorization', 219 | 'value': 'Bearer ' + self.access_token 220 | }, 221 | 222 | } 223 | 224 | def to_debug_report(self): 225 | """ 226 | Gets the essential information for debugging. 227 | 228 | :return: The report for debugging. 229 | """ 230 | return "Python SDK Debug Report:\n"\ 231 | "OS: {env}\n"\ 232 | "Python Version: {pyversion}\n"\ 233 | "Version of the API: v2\n"\ 234 | "SDK Package Version: 1.0.0".\ 235 | format(env=sys.platform, pyversion=sys.version) 236 | -------------------------------------------------------------------------------- /docusign_click/models/user_agreement_request.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | DocuSign Click API 5 | 6 | Elastic signing (also known as DocuSign Click) lets you capture consent to standard agreement terms with a single click: terms and conditions, terms of service, terms of use, privacy policies, and more. The Click API lets you include this customizable elastic template solution in your DocuSign integrations. # noqa: E501 7 | 8 | OpenAPI spec version: v1 9 | Contact: devcenter@docusign.com 10 | Generated by: https://github.com/swagger-api/swagger-codegen.git 11 | """ 12 | 13 | 14 | import pprint 15 | import re # noqa: F401 16 | 17 | import six 18 | 19 | from docusign_click.client.configuration import Configuration 20 | 21 | 22 | class UserAgreementRequest(object): 23 | """NOTE: This class is auto generated by the swagger code generator program. 24 | 25 | Do not edit the class manually. 26 | """ 27 | 28 | """ 29 | Attributes: 30 | swagger_types (dict): The key is attribute name 31 | and the value is attribute type. 32 | attribute_map (dict): The key is attribute name 33 | and the value is json key in definition. 34 | """ 35 | swagger_types = { 36 | 'client_user_id': 'str', 37 | 'document_data': 'dict(str, str)', 38 | 'metadata': 'str', 39 | 'return_url': 'str' 40 | } 41 | 42 | attribute_map = { 43 | 'client_user_id': 'clientUserId', 44 | 'document_data': 'documentData', 45 | 'metadata': 'metadata', 46 | 'return_url': 'returnUrl' 47 | } 48 | 49 | def __init__(self, _configuration=None, **kwargs): # noqa: E501 50 | """UserAgreementRequest - a model defined in Swagger""" # noqa: E501 51 | if _configuration is None: 52 | _configuration = Configuration() 53 | self._configuration = _configuration 54 | 55 | self._client_user_id = None 56 | self._document_data = None 57 | self._metadata = None 58 | self._return_url = None 59 | self.discriminator = None 60 | 61 | setattr(self, "_{}".format('client_user_id'), kwargs.get('client_user_id', None)) 62 | setattr(self, "_{}".format('document_data'), kwargs.get('document_data', None)) 63 | setattr(self, "_{}".format('metadata'), kwargs.get('metadata', None)) 64 | setattr(self, "_{}".format('return_url'), kwargs.get('return_url', None)) 65 | 66 | @property 67 | def client_user_id(self): 68 | """Gets the client_user_id of this UserAgreementRequest. # noqa: E501 69 | 70 | A unique value that identifies a user. You can use anything that your system uses to identify unique users, such as employee IDs, email addresses, and surrogate keys as the value of `clientUserId`. A clickwrap with a specific `clientUserId` will not appear again once it has been accepted. # noqa: E501 71 | 72 | :return: The client_user_id of this UserAgreementRequest. # noqa: E501 73 | :rtype: str 74 | """ 75 | return self._client_user_id 76 | 77 | @client_user_id.setter 78 | def client_user_id(self, client_user_id): 79 | """Sets the client_user_id of this UserAgreementRequest. 80 | 81 | A unique value that identifies a user. You can use anything that your system uses to identify unique users, such as employee IDs, email addresses, and surrogate keys as the value of `clientUserId`. A clickwrap with a specific `clientUserId` will not appear again once it has been accepted. # noqa: E501 82 | 83 | :param client_user_id: The client_user_id of this UserAgreementRequest. # noqa: E501 84 | :type: str 85 | """ 86 | 87 | self._client_user_id = client_user_id 88 | 89 | @property 90 | def document_data(self): 91 | """Gets the document_data of this UserAgreementRequest. # noqa: E501 92 | 93 | This property specifies the data used to create a clickwrap with [dynamic content][]. [dynamic content]: /docs/click-api/click101/customize-clickwrap-fields/#embed-clickwraps-that-contain-dynamic-content # noqa: E501 94 | 95 | :return: The document_data of this UserAgreementRequest. # noqa: E501 96 | :rtype: dict(str, str) 97 | """ 98 | return self._document_data 99 | 100 | @document_data.setter 101 | def document_data(self, document_data): 102 | """Sets the document_data of this UserAgreementRequest. 103 | 104 | This property specifies the data used to create a clickwrap with [dynamic content][]. [dynamic content]: /docs/click-api/click101/customize-clickwrap-fields/#embed-clickwraps-that-contain-dynamic-content # noqa: E501 105 | 106 | :param document_data: The document_data of this UserAgreementRequest. # noqa: E501 107 | :type: dict(str, str) 108 | """ 109 | 110 | self._document_data = document_data 111 | 112 | @property 113 | def metadata(self): 114 | """Gets the metadata of this UserAgreementRequest. # noqa: E501 115 | 116 | A customer-defined string you can use in requests. This string will appear in the corresponding response. # noqa: E501 117 | 118 | :return: The metadata of this UserAgreementRequest. # noqa: E501 119 | :rtype: str 120 | """ 121 | return self._metadata 122 | 123 | @metadata.setter 124 | def metadata(self, metadata): 125 | """Sets the metadata of this UserAgreementRequest. 126 | 127 | A customer-defined string you can use in requests. This string will appear in the corresponding response. # noqa: E501 128 | 129 | :param metadata: The metadata of this UserAgreementRequest. # noqa: E501 130 | :type: str 131 | """ 132 | 133 | self._metadata = metadata 134 | 135 | @property 136 | def return_url(self): 137 | """Gets the return_url of this UserAgreementRequest. # noqa: E501 138 | 139 | The URL to redirect to after the agreement is complete when the agreement is not rendered in an iframe. # noqa: E501 140 | 141 | :return: The return_url of this UserAgreementRequest. # noqa: E501 142 | :rtype: str 143 | """ 144 | return self._return_url 145 | 146 | @return_url.setter 147 | def return_url(self, return_url): 148 | """Sets the return_url of this UserAgreementRequest. 149 | 150 | The URL to redirect to after the agreement is complete when the agreement is not rendered in an iframe. # noqa: E501 151 | 152 | :param return_url: The return_url of this UserAgreementRequest. # noqa: E501 153 | :type: str 154 | """ 155 | 156 | self._return_url = return_url 157 | 158 | def to_dict(self): 159 | """Returns the model properties as a dict""" 160 | result = {} 161 | 162 | for attr, _ in six.iteritems(self.swagger_types): 163 | value = getattr(self, attr) 164 | if isinstance(value, list): 165 | result[attr] = list(map( 166 | lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 167 | value 168 | )) 169 | elif hasattr(value, "to_dict"): 170 | result[attr] = value.to_dict() 171 | elif isinstance(value, dict): 172 | result[attr] = dict(map( 173 | lambda item: (item[0], item[1].to_dict()) 174 | if hasattr(item[1], "to_dict") else item, 175 | value.items() 176 | )) 177 | else: 178 | result[attr] = value 179 | if issubclass(UserAgreementRequest, dict): 180 | for key, value in self.items(): 181 | result[key] = value 182 | 183 | return result 184 | 185 | def to_str(self): 186 | """Returns the string representation of the model""" 187 | return pprint.pformat(self.to_dict()) 188 | 189 | def __repr__(self): 190 | """For `print` and `pprint`""" 191 | return self.to_str() 192 | 193 | def __eq__(self, other): 194 | """Returns true if both objects are equal""" 195 | if not isinstance(other, UserAgreementRequest): 196 | return False 197 | 198 | return self.to_dict() == other.to_dict() 199 | 200 | def __ne__(self, other): 201 | """Returns true if both objects are not equal""" 202 | if not isinstance(other, UserAgreementRequest): 203 | return True 204 | 205 | return self.to_dict() != other.to_dict() 206 | -------------------------------------------------------------------------------- /docusign_click/models/container_styles.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | DocuSign Click API 5 | 6 | Elastic signing (also known as DocuSign Click) lets you capture consent to standard agreement terms with a single click: terms and conditions, terms of service, terms of use, privacy policies, and more. The Click API lets you include this customizable elastic template solution in your DocuSign integrations. # noqa: E501 7 | 8 | OpenAPI spec version: v1 9 | Contact: devcenter@docusign.com 10 | Generated by: https://github.com/swagger-api/swagger-codegen.git 11 | """ 12 | 13 | 14 | import pprint 15 | import re # noqa: F401 16 | 17 | import six 18 | 19 | from docusign_click.client.configuration import Configuration 20 | 21 | 22 | class ContainerStyles(object): 23 | """NOTE: This class is auto generated by the swagger code generator program. 24 | 25 | Do not edit the class manually. 26 | """ 27 | 28 | """ 29 | Attributes: 30 | swagger_types (dict): The key is attribute name 31 | and the value is attribute type. 32 | attribute_map (dict): The key is attribute name 33 | and the value is json key in definition. 34 | """ 35 | swagger_types = { 36 | 'background_color': 'str', 37 | 'border_color': 'str', 38 | 'border_radius': 'str', 39 | 'border_style': 'str', 40 | 'border_width': 'str' 41 | } 42 | 43 | attribute_map = { 44 | 'background_color': 'backgroundColor', 45 | 'border_color': 'borderColor', 46 | 'border_radius': 'borderRadius', 47 | 'border_style': 'borderStyle', 48 | 'border_width': 'borderWidth' 49 | } 50 | 51 | def __init__(self, _configuration=None, **kwargs): # noqa: E501 52 | """ContainerStyles - a model defined in Swagger""" # noqa: E501 53 | if _configuration is None: 54 | _configuration = Configuration() 55 | self._configuration = _configuration 56 | 57 | self._background_color = None 58 | self._border_color = None 59 | self._border_radius = None 60 | self._border_style = None 61 | self._border_width = None 62 | self.discriminator = None 63 | 64 | setattr(self, "_{}".format('background_color'), kwargs.get('background_color', None)) 65 | setattr(self, "_{}".format('border_color'), kwargs.get('border_color', None)) 66 | setattr(self, "_{}".format('border_radius'), kwargs.get('border_radius', None)) 67 | setattr(self, "_{}".format('border_style'), kwargs.get('border_style', None)) 68 | setattr(self, "_{}".format('border_width'), kwargs.get('border_width', None)) 69 | 70 | @property 71 | def background_color(self): 72 | """Gets the background_color of this ContainerStyles. # noqa: E501 73 | 74 | This will be restricted to values not equal to: 'transparent', 'none' # noqa: E501 75 | 76 | :return: The background_color of this ContainerStyles. # noqa: E501 77 | :rtype: str 78 | """ 79 | return self._background_color 80 | 81 | @background_color.setter 82 | def background_color(self, background_color): 83 | """Sets the background_color of this ContainerStyles. 84 | 85 | This will be restricted to values not equal to: 'transparent', 'none' # noqa: E501 86 | 87 | :param background_color: The background_color of this ContainerStyles. # noqa: E501 88 | :type: str 89 | """ 90 | 91 | self._background_color = background_color 92 | 93 | @property 94 | def border_color(self): 95 | """Gets the border_color of this ContainerStyles. # noqa: E501 96 | 97 | Adjust the border color of the clickwrap surrouding container. # noqa: E501 98 | 99 | :return: The border_color of this ContainerStyles. # noqa: E501 100 | :rtype: str 101 | """ 102 | return self._border_color 103 | 104 | @border_color.setter 105 | def border_color(self, border_color): 106 | """Sets the border_color of this ContainerStyles. 107 | 108 | Adjust the border color of the clickwrap surrouding container. # noqa: E501 109 | 110 | :param border_color: The border_color of this ContainerStyles. # noqa: E501 111 | :type: str 112 | """ 113 | 114 | self._border_color = border_color 115 | 116 | @property 117 | def border_radius(self): 118 | """Gets the border_radius of this ContainerStyles. # noqa: E501 119 | 120 | Adjust the border radius of the clickwrap surrouding container. # noqa: E501 121 | 122 | :return: The border_radius of this ContainerStyles. # noqa: E501 123 | :rtype: str 124 | """ 125 | return self._border_radius 126 | 127 | @border_radius.setter 128 | def border_radius(self, border_radius): 129 | """Sets the border_radius of this ContainerStyles. 130 | 131 | Adjust the border radius of the clickwrap surrouding container. # noqa: E501 132 | 133 | :param border_radius: The border_radius of this ContainerStyles. # noqa: E501 134 | :type: str 135 | """ 136 | 137 | self._border_radius = border_radius 138 | 139 | @property 140 | def border_style(self): 141 | """Gets the border_style of this ContainerStyles. # noqa: E501 142 | 143 | Adjust the border style of the clickwrap surrouding container. # noqa: E501 144 | 145 | :return: The border_style of this ContainerStyles. # noqa: E501 146 | :rtype: str 147 | """ 148 | return self._border_style 149 | 150 | @border_style.setter 151 | def border_style(self, border_style): 152 | """Sets the border_style of this ContainerStyles. 153 | 154 | Adjust the border style of the clickwrap surrouding container. # noqa: E501 155 | 156 | :param border_style: The border_style of this ContainerStyles. # noqa: E501 157 | :type: str 158 | """ 159 | 160 | self._border_style = border_style 161 | 162 | @property 163 | def border_width(self): 164 | """Gets the border_width of this ContainerStyles. # noqa: E501 165 | 166 | Adjust the border width of the clickwrap surrouding container. # noqa: E501 167 | 168 | :return: The border_width of this ContainerStyles. # noqa: E501 169 | :rtype: str 170 | """ 171 | return self._border_width 172 | 173 | @border_width.setter 174 | def border_width(self, border_width): 175 | """Sets the border_width of this ContainerStyles. 176 | 177 | Adjust the border width of the clickwrap surrouding container. # noqa: E501 178 | 179 | :param border_width: The border_width of this ContainerStyles. # noqa: E501 180 | :type: str 181 | """ 182 | 183 | self._border_width = border_width 184 | 185 | def to_dict(self): 186 | """Returns the model properties as a dict""" 187 | result = {} 188 | 189 | for attr, _ in six.iteritems(self.swagger_types): 190 | value = getattr(self, attr) 191 | if isinstance(value, list): 192 | result[attr] = list(map( 193 | lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 194 | value 195 | )) 196 | elif hasattr(value, "to_dict"): 197 | result[attr] = value.to_dict() 198 | elif isinstance(value, dict): 199 | result[attr] = dict(map( 200 | lambda item: (item[0], item[1].to_dict()) 201 | if hasattr(item[1], "to_dict") else item, 202 | value.items() 203 | )) 204 | else: 205 | result[attr] = value 206 | if issubclass(ContainerStyles, dict): 207 | for key, value in self.items(): 208 | result[key] = value 209 | 210 | return result 211 | 212 | def to_str(self): 213 | """Returns the string representation of the model""" 214 | return pprint.pformat(self.to_dict()) 215 | 216 | def __repr__(self): 217 | """For `print` and `pprint`""" 218 | return self.to_str() 219 | 220 | def __eq__(self, other): 221 | """Returns true if both objects are equal""" 222 | if not isinstance(other, ContainerStyles): 223 | return False 224 | 225 | return self.to_dict() == other.to_dict() 226 | 227 | def __ne__(self, other): 228 | """Returns true if both objects are not equal""" 229 | if not isinstance(other, ContainerStyles): 230 | return True 231 | 232 | return self.to_dict() != other.to_dict() 233 | -------------------------------------------------------------------------------- /docusign_click/models/document_data.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | DocuSign Click API 5 | 6 | DocuSign Click lets you capture consent to standard agreement terms with a single click: terms and conditions, terms of service, terms of use, privacy policies, and more. The Click API lets you include this customizable clickwrap solution in your DocuSign integrations. # noqa: E501 7 | 8 | OpenAPI spec version: v1 9 | Contact: devcenter@docusign.com 10 | Generated by: https://github.com/swagger-api/swagger-codegen.git 11 | """ 12 | 13 | 14 | import pprint 15 | import re # noqa: F401 16 | 17 | import six 18 | 19 | from docusign_click.client.configuration import Configuration 20 | 21 | 22 | class DocumentData(object): 23 | """NOTE: This class is auto generated by the swagger code generator program. 24 | 25 | Do not edit the class manually. 26 | """ 27 | 28 | """ 29 | Attributes: 30 | swagger_types (dict): The key is attribute name 31 | and the value is attribute type. 32 | attribute_map (dict): The key is attribute name 33 | and the value is json key in definition. 34 | """ 35 | swagger_types = { 36 | 'full_name': 'str', 37 | 'email': 'str', 38 | 'company': 'str', 39 | 'job_title': 'str', 40 | '_date': 'str' 41 | } 42 | 43 | attribute_map = { 44 | 'full_name': 'fullName', 45 | 'email': 'email', 46 | 'company': 'company', 47 | 'job_title': 'jobTitle', 48 | '_date': 'date' 49 | } 50 | 51 | def __init__(self, _configuration=None, **kwargs): # noqa: E501 52 | """DocumentData - a model defined in Swagger""" # noqa: E501 53 | if _configuration is None: 54 | _configuration = Configuration() 55 | self._configuration = _configuration 56 | 57 | self._full_name = None 58 | self._email = None 59 | self._company = None 60 | self._job_title = None 61 | self.__date = None 62 | self.discriminator = None 63 | 64 | setattr(self, "_{}".format('full_name'), kwargs.get('full_name', None)) 65 | setattr(self, "_{}".format('email'), kwargs.get('email', None)) 66 | setattr(self, "_{}".format('company'), kwargs.get('company', None)) 67 | setattr(self, "_{}".format('job_title'), kwargs.get('job_title', None)) 68 | setattr(self, "_{}".format('_date'), kwargs.get('_date', None)) 69 | 70 | @property 71 | def full_name(self): 72 | """Gets the full_name of this DocumentData. # noqa: E501 73 | 74 | The full name of the signer. This field is created in the UI editor for a Clickwrap document. Only required if present in the document. # noqa: E501 75 | 76 | :return: The full_name of this DocumentData. # noqa: E501 77 | :rtype: str 78 | """ 79 | return self._full_name 80 | 81 | @full_name.setter 82 | def full_name(self, full_name): 83 | """Sets the full_name of this DocumentData. 84 | 85 | The full name of the signer. This field is created in the UI editor for a Clickwrap document. Only required if present in the document. # noqa: E501 86 | 87 | :param full_name: The full_name of this DocumentData. # noqa: E501 88 | :type: str 89 | """ 90 | 91 | self._full_name = full_name 92 | 93 | @property 94 | def email(self): 95 | """Gets the email of this DocumentData. # noqa: E501 96 | 97 | The email address of the signer. This field is created in the UI editor for a Clickwrap document. Only required if present in the document. # noqa: E501 98 | 99 | :return: The email of this DocumentData. # noqa: E501 100 | :rtype: str 101 | """ 102 | return self._email 103 | 104 | @email.setter 105 | def email(self, email): 106 | """Sets the email of this DocumentData. 107 | 108 | The email address of the signer. This field is created in the UI editor for a Clickwrap document. Only required if present in the document. # noqa: E501 109 | 110 | :param email: The email of this DocumentData. # noqa: E501 111 | :type: str 112 | """ 113 | 114 | self._email = email 115 | 116 | @property 117 | def company(self): 118 | """Gets the company of this DocumentData. # noqa: E501 119 | 120 | The company name of the signer. This field is created in the UI editor for a Clickwrap document. Only required if present in the document. # noqa: E501 121 | 122 | :return: The company of this DocumentData. # noqa: E501 123 | :rtype: str 124 | """ 125 | return self._company 126 | 127 | @company.setter 128 | def company(self, company): 129 | """Sets the company of this DocumentData. 130 | 131 | The company name of the signer. This field is created in the UI editor for a Clickwrap document. Only required if present in the document. # noqa: E501 132 | 133 | :param company: The company of this DocumentData. # noqa: E501 134 | :type: str 135 | """ 136 | 137 | self._company = company 138 | 139 | @property 140 | def job_title(self): 141 | """Gets the job_title of this DocumentData. # noqa: E501 142 | 143 | The job title of the signer. This field is created in the UI editor for a Clickwrap document. Only required if present in the document. # noqa: E501 144 | 145 | :return: The job_title of this DocumentData. # noqa: E501 146 | :rtype: str 147 | """ 148 | return self._job_title 149 | 150 | @job_title.setter 151 | def job_title(self, job_title): 152 | """Sets the job_title of this DocumentData. 153 | 154 | The job title of the signer. This field is created in the UI editor for a Clickwrap document. Only required if present in the document. # noqa: E501 155 | 156 | :param job_title: The job_title of this DocumentData. # noqa: E501 157 | :type: str 158 | """ 159 | 160 | self._job_title = job_title 161 | 162 | @property 163 | def _date(self): 164 | """Gets the _date of this DocumentData. # noqa: E501 165 | 166 | A custom date for the contract. This field is created in the UI editor for a Clickwrap document. Only required if present in the document. # noqa: E501 167 | 168 | :return: The _date of this DocumentData. # noqa: E501 169 | :rtype: str 170 | """ 171 | return self.__date 172 | 173 | @_date.setter 174 | def _date(self, _date): 175 | """Sets the _date of this DocumentData. 176 | 177 | A custom date for the contract. This field is created in the UI editor for a Clickwrap document. Only required if present in the document. # noqa: E501 178 | 179 | :param _date: The _date of this DocumentData. # noqa: E501 180 | :type: str 181 | """ 182 | 183 | self.__date = _date 184 | 185 | def to_dict(self): 186 | """Returns the model properties as a dict""" 187 | result = {} 188 | 189 | for attr, _ in six.iteritems(self.swagger_types): 190 | value = getattr(self, attr) 191 | if isinstance(value, list): 192 | result[attr] = list(map( 193 | lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 194 | value 195 | )) 196 | elif hasattr(value, "to_dict"): 197 | result[attr] = value.to_dict() 198 | elif isinstance(value, dict): 199 | result[attr] = dict(map( 200 | lambda item: (item[0], item[1].to_dict()) 201 | if hasattr(item[1], "to_dict") else item, 202 | value.items() 203 | )) 204 | else: 205 | result[attr] = value 206 | if issubclass(DocumentData, dict): 207 | for key, value in self.items(): 208 | result[key] = value 209 | 210 | return result 211 | 212 | def to_str(self): 213 | """Returns the string representation of the model""" 214 | return pprint.pformat(self.to_dict()) 215 | 216 | def __repr__(self): 217 | """For `print` and `pprint`""" 218 | return self.to_str() 219 | 220 | def __eq__(self, other): 221 | """Returns true if both objects are equal""" 222 | if not isinstance(other, DocumentData): 223 | return False 224 | 225 | return self.to_dict() == other.to_dict() 226 | 227 | def __ne__(self, other): 228 | """Returns true if both objects are not equal""" 229 | if not isinstance(other, DocumentData): 230 | return True 231 | 232 | return self.to_dict() != other.to_dict() 233 | -------------------------------------------------------------------------------- /docusign_click/models/clickwrap_agreements_response.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | DocuSign Click API 5 | 6 | Elastic signing (also known as DocuSign Click) lets you capture consent to standard agreement terms with a single click: terms and conditions, terms of service, terms of use, privacy policies, and more. The Click API lets you include this customizable elastic template solution in your DocuSign integrations. # noqa: E501 7 | 8 | OpenAPI spec version: v1 9 | Contact: devcenter@docusign.com 10 | Generated by: https://github.com/swagger-api/swagger-codegen.git 11 | """ 12 | 13 | 14 | import pprint 15 | import re # noqa: F401 16 | 17 | import six 18 | 19 | from docusign_click.client.configuration import Configuration 20 | 21 | 22 | class ClickwrapAgreementsResponse(object): 23 | """NOTE: This class is auto generated by the swagger code generator program. 24 | 25 | Do not edit the class manually. 26 | """ 27 | 28 | """ 29 | Attributes: 30 | swagger_types (dict): The key is attribute name 31 | and the value is attribute type. 32 | attribute_map (dict): The key is attribute name 33 | and the value is json key in definition. 34 | """ 35 | swagger_types = { 36 | 'begin_created_on': 'object', 37 | 'minimum_pages_remaining': 'int', 38 | 'page': 'int', 39 | 'page_size': 'int', 40 | 'user_agreements': 'list[UserAgreementResponse]' 41 | } 42 | 43 | attribute_map = { 44 | 'begin_created_on': 'beginCreatedOn', 45 | 'minimum_pages_remaining': 'minimumPagesRemaining', 46 | 'page': 'page', 47 | 'page_size': 'pageSize', 48 | 'user_agreements': 'userAgreements' 49 | } 50 | 51 | def __init__(self, _configuration=None, **kwargs): # noqa: E501 52 | """ClickwrapAgreementsResponse - a model defined in Swagger""" # noqa: E501 53 | if _configuration is None: 54 | _configuration = Configuration() 55 | self._configuration = _configuration 56 | 57 | self._begin_created_on = None 58 | self._minimum_pages_remaining = None 59 | self._page = None 60 | self._page_size = None 61 | self._user_agreements = None 62 | self.discriminator = None 63 | 64 | setattr(self, "_{}".format('begin_created_on'), kwargs.get('begin_created_on', None)) 65 | setattr(self, "_{}".format('minimum_pages_remaining'), kwargs.get('minimum_pages_remaining', None)) 66 | setattr(self, "_{}".format('page'), kwargs.get('page', None)) 67 | setattr(self, "_{}".format('page_size'), kwargs.get('page_size', None)) 68 | setattr(self, "_{}".format('user_agreements'), kwargs.get('user_agreements', None)) 69 | 70 | @property 71 | def begin_created_on(self): 72 | """Gets the begin_created_on of this ClickwrapAgreementsResponse. # noqa: E501 73 | 74 | User agreements from this datetime. # noqa: E501 75 | 76 | :return: The begin_created_on of this ClickwrapAgreementsResponse. # noqa: E501 77 | :rtype: object 78 | """ 79 | return self._begin_created_on 80 | 81 | @begin_created_on.setter 82 | def begin_created_on(self, begin_created_on): 83 | """Sets the begin_created_on of this ClickwrapAgreementsResponse. 84 | 85 | User agreements from this datetime. # noqa: E501 86 | 87 | :param begin_created_on: The begin_created_on of this ClickwrapAgreementsResponse. # noqa: E501 88 | :type: object 89 | """ 90 | 91 | self._begin_created_on = begin_created_on 92 | 93 | @property 94 | def minimum_pages_remaining(self): 95 | """Gets the minimum_pages_remaining of this ClickwrapAgreementsResponse. # noqa: E501 96 | 97 | Number of pages remaining in the response. # noqa: E501 98 | 99 | :return: The minimum_pages_remaining of this ClickwrapAgreementsResponse. # noqa: E501 100 | :rtype: int 101 | """ 102 | return self._minimum_pages_remaining 103 | 104 | @minimum_pages_remaining.setter 105 | def minimum_pages_remaining(self, minimum_pages_remaining): 106 | """Sets the minimum_pages_remaining of this ClickwrapAgreementsResponse. 107 | 108 | Number of pages remaining in the response. # noqa: E501 109 | 110 | :param minimum_pages_remaining: The minimum_pages_remaining of this ClickwrapAgreementsResponse. # noqa: E501 111 | :type: int 112 | """ 113 | 114 | self._minimum_pages_remaining = minimum_pages_remaining 115 | 116 | @property 117 | def page(self): 118 | """Gets the page of this ClickwrapAgreementsResponse. # noqa: E501 119 | 120 | The number of the current page. # noqa: E501 121 | 122 | :return: The page of this ClickwrapAgreementsResponse. # noqa: E501 123 | :rtype: int 124 | """ 125 | return self._page 126 | 127 | @page.setter 128 | def page(self, page): 129 | """Sets the page of this ClickwrapAgreementsResponse. 130 | 131 | The number of the current page. # noqa: E501 132 | 133 | :param page: The page of this ClickwrapAgreementsResponse. # noqa: E501 134 | :type: int 135 | """ 136 | 137 | self._page = page 138 | 139 | @property 140 | def page_size(self): 141 | """Gets the page_size of this ClickwrapAgreementsResponse. # noqa: E501 142 | 143 | The number of items per page. # noqa: E501 144 | 145 | :return: The page_size of this ClickwrapAgreementsResponse. # noqa: E501 146 | :rtype: int 147 | """ 148 | return self._page_size 149 | 150 | @page_size.setter 151 | def page_size(self, page_size): 152 | """Sets the page_size of this ClickwrapAgreementsResponse. 153 | 154 | The number of items per page. # noqa: E501 155 | 156 | :param page_size: The page_size of this ClickwrapAgreementsResponse. # noqa: E501 157 | :type: int 158 | """ 159 | 160 | self._page_size = page_size 161 | 162 | @property 163 | def user_agreements(self): 164 | """Gets the user_agreements of this ClickwrapAgreementsResponse. # noqa: E501 165 | 166 | An array of user agreements. # noqa: E501 167 | 168 | :return: The user_agreements of this ClickwrapAgreementsResponse. # noqa: E501 169 | :rtype: list[UserAgreementResponse] 170 | """ 171 | return self._user_agreements 172 | 173 | @user_agreements.setter 174 | def user_agreements(self, user_agreements): 175 | """Sets the user_agreements of this ClickwrapAgreementsResponse. 176 | 177 | An array of user agreements. # noqa: E501 178 | 179 | :param user_agreements: The user_agreements of this ClickwrapAgreementsResponse. # noqa: E501 180 | :type: list[UserAgreementResponse] 181 | """ 182 | 183 | self._user_agreements = user_agreements 184 | 185 | def to_dict(self): 186 | """Returns the model properties as a dict""" 187 | result = {} 188 | 189 | for attr, _ in six.iteritems(self.swagger_types): 190 | value = getattr(self, attr) 191 | if isinstance(value, list): 192 | result[attr] = list(map( 193 | lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 194 | value 195 | )) 196 | elif hasattr(value, "to_dict"): 197 | result[attr] = value.to_dict() 198 | elif isinstance(value, dict): 199 | result[attr] = dict(map( 200 | lambda item: (item[0], item[1].to_dict()) 201 | if hasattr(item[1], "to_dict") else item, 202 | value.items() 203 | )) 204 | else: 205 | result[attr] = value 206 | if issubclass(ClickwrapAgreementsResponse, dict): 207 | for key, value in self.items(): 208 | result[key] = value 209 | 210 | return result 211 | 212 | def to_str(self): 213 | """Returns the string representation of the model""" 214 | return pprint.pformat(self.to_dict()) 215 | 216 | def __repr__(self): 217 | """For `print` and `pprint`""" 218 | return self.to_str() 219 | 220 | def __eq__(self, other): 221 | """Returns true if both objects are equal""" 222 | if not isinstance(other, ClickwrapAgreementsResponse): 223 | return False 224 | 225 | return self.to_dict() == other.to_dict() 226 | 227 | def __ne__(self, other): 228 | """Returns true if both objects are not equal""" 229 | if not isinstance(other, ClickwrapAgreementsResponse): 230 | return True 231 | 232 | return self.to_dict() != other.to_dict() 233 | -------------------------------------------------------------------------------- /docusign_click/models/clickwrap_delete_response.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | DocuSign Click API 5 | 6 | Elastic signing (also known as DocuSign Click) lets you capture consent to standard agreement terms with a single click: terms and conditions, terms of service, terms of use, privacy policies, and more. The Click API lets you include this customizable elastic template solution in your DocuSign integrations. # noqa: E501 7 | 8 | OpenAPI spec version: v1 9 | Contact: devcenter@docusign.com 10 | Generated by: https://github.com/swagger-api/swagger-codegen.git 11 | """ 12 | 13 | 14 | import pprint 15 | import re # noqa: F401 16 | 17 | import six 18 | 19 | from docusign_click.client.configuration import Configuration 20 | 21 | 22 | class ClickwrapDeleteResponse(object): 23 | """NOTE: This class is auto generated by the swagger code generator program. 24 | 25 | Do not edit the class manually. 26 | """ 27 | 28 | """ 29 | Attributes: 30 | swagger_types (dict): The key is attribute name 31 | and the value is attribute type. 32 | attribute_map (dict): The key is attribute name 33 | and the value is json key in definition. 34 | """ 35 | swagger_types = { 36 | 'clickwrap_id': 'str', 37 | 'clickwrap_name': 'str', 38 | 'deletion_message': 'str', 39 | 'deletion_success': 'bool', 40 | 'status': 'str' 41 | } 42 | 43 | attribute_map = { 44 | 'clickwrap_id': 'clickwrapId', 45 | 'clickwrap_name': 'clickwrapName', 46 | 'deletion_message': 'deletionMessage', 47 | 'deletion_success': 'deletionSuccess', 48 | 'status': 'status' 49 | } 50 | 51 | def __init__(self, _configuration=None, **kwargs): # noqa: E501 52 | """ClickwrapDeleteResponse - a model defined in Swagger""" # noqa: E501 53 | if _configuration is None: 54 | _configuration = Configuration() 55 | self._configuration = _configuration 56 | 57 | self._clickwrap_id = None 58 | self._clickwrap_name = None 59 | self._deletion_message = None 60 | self._deletion_success = None 61 | self._status = None 62 | self.discriminator = None 63 | 64 | setattr(self, "_{}".format('clickwrap_id'), kwargs.get('clickwrap_id', None)) 65 | setattr(self, "_{}".format('clickwrap_name'), kwargs.get('clickwrap_name', None)) 66 | setattr(self, "_{}".format('deletion_message'), kwargs.get('deletion_message', None)) 67 | setattr(self, "_{}".format('deletion_success'), kwargs.get('deletion_success', None)) 68 | setattr(self, "_{}".format('status'), kwargs.get('status', None)) 69 | 70 | @property 71 | def clickwrap_id(self): 72 | """Gets the clickwrap_id of this ClickwrapDeleteResponse. # noqa: E501 73 | 74 | The ID of the clickwrap. # noqa: E501 75 | 76 | :return: The clickwrap_id of this ClickwrapDeleteResponse. # noqa: E501 77 | :rtype: str 78 | """ 79 | return self._clickwrap_id 80 | 81 | @clickwrap_id.setter 82 | def clickwrap_id(self, clickwrap_id): 83 | """Sets the clickwrap_id of this ClickwrapDeleteResponse. 84 | 85 | The ID of the clickwrap. # noqa: E501 86 | 87 | :param clickwrap_id: The clickwrap_id of this ClickwrapDeleteResponse. # noqa: E501 88 | :type: str 89 | """ 90 | 91 | self._clickwrap_id = clickwrap_id 92 | 93 | @property 94 | def clickwrap_name(self): 95 | """Gets the clickwrap_name of this ClickwrapDeleteResponse. # noqa: E501 96 | 97 | The name of the clickwrap. # noqa: E501 98 | 99 | :return: The clickwrap_name of this ClickwrapDeleteResponse. # noqa: E501 100 | :rtype: str 101 | """ 102 | return self._clickwrap_name 103 | 104 | @clickwrap_name.setter 105 | def clickwrap_name(self, clickwrap_name): 106 | """Sets the clickwrap_name of this ClickwrapDeleteResponse. 107 | 108 | The name of the clickwrap. # noqa: E501 109 | 110 | :param clickwrap_name: The clickwrap_name of this ClickwrapDeleteResponse. # noqa: E501 111 | :type: str 112 | """ 113 | 114 | self._clickwrap_name = clickwrap_name 115 | 116 | @property 117 | def deletion_message(self): 118 | """Gets the deletion_message of this ClickwrapDeleteResponse. # noqa: E501 119 | 120 | A message describing the result of deletion request. One of: - `alreadyDeleted`: Clickwrap is already deleted. - `deletionSuccess`: Successfully deleted the clickwrap. - `deletionFailure`: Failed to delete the clickwrap. - `cannotDelete`: Active clickwrap version cannot be deleted. # noqa: E501 121 | 122 | :return: The deletion_message of this ClickwrapDeleteResponse. # noqa: E501 123 | :rtype: str 124 | """ 125 | return self._deletion_message 126 | 127 | @deletion_message.setter 128 | def deletion_message(self, deletion_message): 129 | """Sets the deletion_message of this ClickwrapDeleteResponse. 130 | 131 | A message describing the result of deletion request. One of: - `alreadyDeleted`: Clickwrap is already deleted. - `deletionSuccess`: Successfully deleted the clickwrap. - `deletionFailure`: Failed to delete the clickwrap. - `cannotDelete`: Active clickwrap version cannot be deleted. # noqa: E501 132 | 133 | :param deletion_message: The deletion_message of this ClickwrapDeleteResponse. # noqa: E501 134 | :type: str 135 | """ 136 | 137 | self._deletion_message = deletion_message 138 | 139 | @property 140 | def deletion_success(self): 141 | """Gets the deletion_success of this ClickwrapDeleteResponse. # noqa: E501 142 | 143 | **True** if the clickwrap was deleted successfully. **False** otherwise. # noqa: E501 144 | 145 | :return: The deletion_success of this ClickwrapDeleteResponse. # noqa: E501 146 | :rtype: bool 147 | """ 148 | return self._deletion_success 149 | 150 | @deletion_success.setter 151 | def deletion_success(self, deletion_success): 152 | """Sets the deletion_success of this ClickwrapDeleteResponse. 153 | 154 | **True** if the clickwrap was deleted successfully. **False** otherwise. # noqa: E501 155 | 156 | :param deletion_success: The deletion_success of this ClickwrapDeleteResponse. # noqa: E501 157 | :type: bool 158 | """ 159 | 160 | self._deletion_success = deletion_success 161 | 162 | @property 163 | def status(self): 164 | """Gets the status of this ClickwrapDeleteResponse. # noqa: E501 165 | 166 | Clickwrap status. Possible values: - `active` - `inactive` - `deleted` # noqa: E501 167 | 168 | :return: The status of this ClickwrapDeleteResponse. # noqa: E501 169 | :rtype: str 170 | """ 171 | return self._status 172 | 173 | @status.setter 174 | def status(self, status): 175 | """Sets the status of this ClickwrapDeleteResponse. 176 | 177 | Clickwrap status. Possible values: - `active` - `inactive` - `deleted` # noqa: E501 178 | 179 | :param status: The status of this ClickwrapDeleteResponse. # noqa: E501 180 | :type: str 181 | """ 182 | 183 | self._status = status 184 | 185 | def to_dict(self): 186 | """Returns the model properties as a dict""" 187 | result = {} 188 | 189 | for attr, _ in six.iteritems(self.swagger_types): 190 | value = getattr(self, attr) 191 | if isinstance(value, list): 192 | result[attr] = list(map( 193 | lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 194 | value 195 | )) 196 | elif hasattr(value, "to_dict"): 197 | result[attr] = value.to_dict() 198 | elif isinstance(value, dict): 199 | result[attr] = dict(map( 200 | lambda item: (item[0], item[1].to_dict()) 201 | if hasattr(item[1], "to_dict") else item, 202 | value.items() 203 | )) 204 | else: 205 | result[attr] = value 206 | if issubclass(ClickwrapDeleteResponse, dict): 207 | for key, value in self.items(): 208 | result[key] = value 209 | 210 | return result 211 | 212 | def to_str(self): 213 | """Returns the string representation of the model""" 214 | return pprint.pformat(self.to_dict()) 215 | 216 | def __repr__(self): 217 | """For `print` and `pprint`""" 218 | return self.to_str() 219 | 220 | def __eq__(self, other): 221 | """Returns true if both objects are equal""" 222 | if not isinstance(other, ClickwrapDeleteResponse): 223 | return False 224 | 225 | return self.to_dict() == other.to_dict() 226 | 227 | def __ne__(self, other): 228 | """Returns true if both objects are not equal""" 229 | if not isinstance(other, ClickwrapDeleteResponse): 230 | return True 231 | 232 | return self.to_dict() != other.to_dict() 233 | -------------------------------------------------------------------------------- /docusign_click/models/agreement_statement_styles.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | DocuSign Click API 5 | 6 | Elastic signing (also known as DocuSign Click) lets you capture consent to standard agreement terms with a single click: terms and conditions, terms of service, terms of use, privacy policies, and more. The Click API lets you include this customizable elastic template solution in your DocuSign integrations. # noqa: E501 7 | 8 | OpenAPI spec version: v1 9 | Contact: devcenter@docusign.com 10 | Generated by: https://github.com/swagger-api/swagger-codegen.git 11 | """ 12 | 13 | 14 | import pprint 15 | import re # noqa: F401 16 | 17 | import six 18 | 19 | from docusign_click.client.configuration import Configuration 20 | 21 | 22 | class AgreementStatementStyles(object): 23 | """NOTE: This class is auto generated by the swagger code generator program. 24 | 25 | Do not edit the class manually. 26 | """ 27 | 28 | """ 29 | Attributes: 30 | swagger_types (dict): The key is attribute name 31 | and the value is attribute type. 32 | attribute_map (dict): The key is attribute name 33 | and the value is json key in definition. 34 | """ 35 | swagger_types = { 36 | 'color': 'str', 37 | 'display': 'str', 38 | 'font_family': 'str', 39 | 'font_size': 'str', 40 | 'font_style': 'str', 41 | 'font_weight': 'object' 42 | } 43 | 44 | attribute_map = { 45 | 'color': 'color', 46 | 'display': 'display', 47 | 'font_family': 'fontFamily', 48 | 'font_size': 'fontSize', 49 | 'font_style': 'fontStyle', 50 | 'font_weight': 'fontWeight' 51 | } 52 | 53 | def __init__(self, _configuration=None, **kwargs): # noqa: E501 54 | """AgreementStatementStyles - a model defined in Swagger""" # noqa: E501 55 | if _configuration is None: 56 | _configuration = Configuration() 57 | self._configuration = _configuration 58 | 59 | self._color = None 60 | self._display = None 61 | self._font_family = None 62 | self._font_size = None 63 | self._font_style = None 64 | self._font_weight = None 65 | self.discriminator = None 66 | 67 | setattr(self, "_{}".format('color'), kwargs.get('color', None)) 68 | setattr(self, "_{}".format('display'), kwargs.get('display', None)) 69 | setattr(self, "_{}".format('font_family'), kwargs.get('font_family', None)) 70 | setattr(self, "_{}".format('font_size'), kwargs.get('font_size', None)) 71 | setattr(self, "_{}".format('font_style'), kwargs.get('font_style', None)) 72 | setattr(self, "_{}".format('font_weight'), kwargs.get('font_weight', None)) 73 | 74 | @property 75 | def color(self): 76 | """Gets the color of this AgreementStatementStyles. # noqa: E501 77 | 78 | Control the fore-ground color of the element. # noqa: E501 79 | 80 | :return: The color of this AgreementStatementStyles. # noqa: E501 81 | :rtype: str 82 | """ 83 | return self._color 84 | 85 | @color.setter 86 | def color(self, color): 87 | """Sets the color of this AgreementStatementStyles. 88 | 89 | Control the fore-ground color of the element. # noqa: E501 90 | 91 | :param color: The color of this AgreementStatementStyles. # noqa: E501 92 | :type: str 93 | """ 94 | 95 | self._color = color 96 | 97 | @property 98 | def display(self): 99 | """Gets the display of this AgreementStatementStyles. # noqa: E501 100 | 101 | Control the display of the header. Can only be set to 'none' over the default for hiding purposes. # noqa: E501 102 | 103 | :return: The display of this AgreementStatementStyles. # noqa: E501 104 | :rtype: str 105 | """ 106 | return self._display 107 | 108 | @display.setter 109 | def display(self, display): 110 | """Sets the display of this AgreementStatementStyles. 111 | 112 | Control the display of the header. Can only be set to 'none' over the default for hiding purposes. # noqa: E501 113 | 114 | :param display: The display of this AgreementStatementStyles. # noqa: E501 115 | :type: str 116 | """ 117 | allowed_values = ["none"] # noqa: E501 118 | if (self._configuration.client_side_validation and 119 | display not in allowed_values): 120 | raise ValueError( 121 | "Invalid value for `display` ({0}), must be one of {1}" # noqa: E501 122 | .format(display, allowed_values) 123 | ) 124 | 125 | self._display = display 126 | 127 | @property 128 | def font_family(self): 129 | """Gets the font_family of this AgreementStatementStyles. # noqa: E501 130 | 131 | Control the font family of the text. # noqa: E501 132 | 133 | :return: The font_family of this AgreementStatementStyles. # noqa: E501 134 | :rtype: str 135 | """ 136 | return self._font_family 137 | 138 | @font_family.setter 139 | def font_family(self, font_family): 140 | """Sets the font_family of this AgreementStatementStyles. 141 | 142 | Control the font family of the text. # noqa: E501 143 | 144 | :param font_family: The font_family of this AgreementStatementStyles. # noqa: E501 145 | :type: str 146 | """ 147 | 148 | self._font_family = font_family 149 | 150 | @property 151 | def font_size(self): 152 | """Gets the font_size of this AgreementStatementStyles. # noqa: E501 153 | 154 | Control the font size of the text. # noqa: E501 155 | 156 | :return: The font_size of this AgreementStatementStyles. # noqa: E501 157 | :rtype: str 158 | """ 159 | return self._font_size 160 | 161 | @font_size.setter 162 | def font_size(self, font_size): 163 | """Sets the font_size of this AgreementStatementStyles. 164 | 165 | Control the font size of the text. # noqa: E501 166 | 167 | :param font_size: The font_size of this AgreementStatementStyles. # noqa: E501 168 | :type: str 169 | """ 170 | 171 | self._font_size = font_size 172 | 173 | @property 174 | def font_style(self): 175 | """Gets the font_style of this AgreementStatementStyles. # noqa: E501 176 | 177 | Control the font style of the text. # noqa: E501 178 | 179 | :return: The font_style of this AgreementStatementStyles. # noqa: E501 180 | :rtype: str 181 | """ 182 | return self._font_style 183 | 184 | @font_style.setter 185 | def font_style(self, font_style): 186 | """Sets the font_style of this AgreementStatementStyles. 187 | 188 | Control the font style of the text. # noqa: E501 189 | 190 | :param font_style: The font_style of this AgreementStatementStyles. # noqa: E501 191 | :type: str 192 | """ 193 | 194 | self._font_style = font_style 195 | 196 | @property 197 | def font_weight(self): 198 | """Gets the font_weight of this AgreementStatementStyles. # noqa: E501 199 | 200 | Control the font weight of the text. # noqa: E501 201 | 202 | :return: The font_weight of this AgreementStatementStyles. # noqa: E501 203 | :rtype: object 204 | """ 205 | return self._font_weight 206 | 207 | @font_weight.setter 208 | def font_weight(self, font_weight): 209 | """Sets the font_weight of this AgreementStatementStyles. 210 | 211 | Control the font weight of the text. # noqa: E501 212 | 213 | :param font_weight: The font_weight of this AgreementStatementStyles. # noqa: E501 214 | :type: object 215 | """ 216 | 217 | self._font_weight = font_weight 218 | 219 | def to_dict(self): 220 | """Returns the model properties as a dict""" 221 | result = {} 222 | 223 | for attr, _ in six.iteritems(self.swagger_types): 224 | value = getattr(self, attr) 225 | if isinstance(value, list): 226 | result[attr] = list(map( 227 | lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 228 | value 229 | )) 230 | elif hasattr(value, "to_dict"): 231 | result[attr] = value.to_dict() 232 | elif isinstance(value, dict): 233 | result[attr] = dict(map( 234 | lambda item: (item[0], item[1].to_dict()) 235 | if hasattr(item[1], "to_dict") else item, 236 | value.items() 237 | )) 238 | else: 239 | result[attr] = value 240 | if issubclass(AgreementStatementStyles, dict): 241 | for key, value in self.items(): 242 | result[key] = value 243 | 244 | return result 245 | 246 | def to_str(self): 247 | """Returns the string representation of the model""" 248 | return pprint.pformat(self.to_dict()) 249 | 250 | def __repr__(self): 251 | """For `print` and `pprint`""" 252 | return self.to_str() 253 | 254 | def __eq__(self, other): 255 | """Returns true if both objects are equal""" 256 | if not isinstance(other, AgreementStatementStyles): 257 | return False 258 | 259 | return self.to_dict() == other.to_dict() 260 | 261 | def __ne__(self, other): 262 | """Returns true if both objects are not equal""" 263 | if not isinstance(other, AgreementStatementStyles): 264 | return True 265 | 266 | return self.to_dict() != other.to_dict() 267 | -------------------------------------------------------------------------------- /docusign_click/models/service_information.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | DocuSign Click API 5 | 6 | Elastic signing (also known as DocuSign Click) lets you capture consent to standard agreement terms with a single click: terms and conditions, terms of service, terms of use, privacy policies, and more. The Click API lets you include this customizable elastic template solution in your DocuSign integrations. # noqa: E501 7 | 8 | OpenAPI spec version: v1 9 | Contact: devcenter@docusign.com 10 | Generated by: https://github.com/swagger-api/swagger-codegen.git 11 | """ 12 | 13 | 14 | import pprint 15 | import re # noqa: F401 16 | 17 | import six 18 | 19 | from docusign_click.client.configuration import Configuration 20 | 21 | 22 | class ServiceInformation(object): 23 | """NOTE: This class is auto generated by the swagger code generator program. 24 | 25 | Do not edit the class manually. 26 | """ 27 | 28 | """ 29 | Attributes: 30 | swagger_types (dict): The key is attribute name 31 | and the value is attribute type. 32 | attribute_map (dict): The key is attribute name 33 | and the value is json key in definition. 34 | """ 35 | swagger_types = { 36 | 'build_branch': 'str', 37 | 'build_branch_deployed_date_time': 'str', 38 | 'build_sha': 'str', 39 | 'build_version': 'str', 40 | 'linked_sites': 'list[str]', 41 | 'service_versions': 'list[ServiceVersion]' 42 | } 43 | 44 | attribute_map = { 45 | 'build_branch': 'buildBranch', 46 | 'build_branch_deployed_date_time': 'buildBranchDeployedDateTime', 47 | 'build_sha': 'buildSHA', 48 | 'build_version': 'buildVersion', 49 | 'linked_sites': 'linkedSites', 50 | 'service_versions': 'serviceVersions' 51 | } 52 | 53 | def __init__(self, _configuration=None, **kwargs): # noqa: E501 54 | """ServiceInformation - a model defined in Swagger""" # noqa: E501 55 | if _configuration is None: 56 | _configuration = Configuration() 57 | self._configuration = _configuration 58 | 59 | self._build_branch = None 60 | self._build_branch_deployed_date_time = None 61 | self._build_sha = None 62 | self._build_version = None 63 | self._linked_sites = None 64 | self._service_versions = None 65 | self.discriminator = None 66 | 67 | setattr(self, "_{}".format('build_branch'), kwargs.get('build_branch', None)) 68 | setattr(self, "_{}".format('build_branch_deployed_date_time'), kwargs.get('build_branch_deployed_date_time', None)) 69 | setattr(self, "_{}".format('build_sha'), kwargs.get('build_sha', None)) 70 | setattr(self, "_{}".format('build_version'), kwargs.get('build_version', None)) 71 | setattr(self, "_{}".format('linked_sites'), kwargs.get('linked_sites', None)) 72 | setattr(self, "_{}".format('service_versions'), kwargs.get('service_versions', None)) 73 | 74 | @property 75 | def build_branch(self): 76 | """Gets the build_branch of this ServiceInformation. # noqa: E501 77 | 78 | The internal source control branch. # noqa: E501 79 | 80 | :return: The build_branch of this ServiceInformation. # noqa: E501 81 | :rtype: str 82 | """ 83 | return self._build_branch 84 | 85 | @build_branch.setter 86 | def build_branch(self, build_branch): 87 | """Sets the build_branch of this ServiceInformation. 88 | 89 | The internal source control branch. # noqa: E501 90 | 91 | :param build_branch: The build_branch of this ServiceInformation. # noqa: E501 92 | :type: str 93 | """ 94 | 95 | self._build_branch = build_branch 96 | 97 | @property 98 | def build_branch_deployed_date_time(self): 99 | """Gets the build_branch_deployed_date_time of this ServiceInformation. # noqa: E501 100 | 101 | The date-time this branch was deployed. # noqa: E501 102 | 103 | :return: The build_branch_deployed_date_time of this ServiceInformation. # noqa: E501 104 | :rtype: str 105 | """ 106 | return self._build_branch_deployed_date_time 107 | 108 | @build_branch_deployed_date_time.setter 109 | def build_branch_deployed_date_time(self, build_branch_deployed_date_time): 110 | """Sets the build_branch_deployed_date_time of this ServiceInformation. 111 | 112 | The date-time this branch was deployed. # noqa: E501 113 | 114 | :param build_branch_deployed_date_time: The build_branch_deployed_date_time of this ServiceInformation. # noqa: E501 115 | :type: str 116 | """ 117 | 118 | self._build_branch_deployed_date_time = build_branch_deployed_date_time 119 | 120 | @property 121 | def build_sha(self): 122 | """Gets the build_sha of this ServiceInformation. # noqa: E501 123 | 124 | The internal source control SHA. # noqa: E501 125 | 126 | :return: The build_sha of this ServiceInformation. # noqa: E501 127 | :rtype: str 128 | """ 129 | return self._build_sha 130 | 131 | @build_sha.setter 132 | def build_sha(self, build_sha): 133 | """Sets the build_sha of this ServiceInformation. 134 | 135 | The internal source control SHA. # noqa: E501 136 | 137 | :param build_sha: The build_sha of this ServiceInformation. # noqa: E501 138 | :type: str 139 | """ 140 | 141 | self._build_sha = build_sha 142 | 143 | @property 144 | def build_version(self): 145 | """Gets the build_version of this ServiceInformation. # noqa: E501 146 | 147 | The internal build version information. # noqa: E501 148 | 149 | :return: The build_version of this ServiceInformation. # noqa: E501 150 | :rtype: str 151 | """ 152 | return self._build_version 153 | 154 | @build_version.setter 155 | def build_version(self, build_version): 156 | """Sets the build_version of this ServiceInformation. 157 | 158 | The internal build version information. # noqa: E501 159 | 160 | :param build_version: The build_version of this ServiceInformation. # noqa: E501 161 | :type: str 162 | """ 163 | 164 | self._build_version = build_version 165 | 166 | @property 167 | def linked_sites(self): 168 | """Gets the linked_sites of this ServiceInformation. # noqa: E501 169 | 170 | An array of URLs (strings) of related sites. # noqa: E501 171 | 172 | :return: The linked_sites of this ServiceInformation. # noqa: E501 173 | :rtype: list[str] 174 | """ 175 | return self._linked_sites 176 | 177 | @linked_sites.setter 178 | def linked_sites(self, linked_sites): 179 | """Sets the linked_sites of this ServiceInformation. 180 | 181 | An array of URLs (strings) of related sites. # noqa: E501 182 | 183 | :param linked_sites: The linked_sites of this ServiceInformation. # noqa: E501 184 | :type: list[str] 185 | """ 186 | 187 | self._linked_sites = linked_sites 188 | 189 | @property 190 | def service_versions(self): 191 | """Gets the service_versions of this ServiceInformation. # noqa: E501 192 | 193 | An array of `serviceVersion` objects. # noqa: E501 194 | 195 | :return: The service_versions of this ServiceInformation. # noqa: E501 196 | :rtype: list[ServiceVersion] 197 | """ 198 | return self._service_versions 199 | 200 | @service_versions.setter 201 | def service_versions(self, service_versions): 202 | """Sets the service_versions of this ServiceInformation. 203 | 204 | An array of `serviceVersion` objects. # noqa: E501 205 | 206 | :param service_versions: The service_versions of this ServiceInformation. # noqa: E501 207 | :type: list[ServiceVersion] 208 | """ 209 | 210 | self._service_versions = service_versions 211 | 212 | def to_dict(self): 213 | """Returns the model properties as a dict""" 214 | result = {} 215 | 216 | for attr, _ in six.iteritems(self.swagger_types): 217 | value = getattr(self, attr) 218 | if isinstance(value, list): 219 | result[attr] = list(map( 220 | lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 221 | value 222 | )) 223 | elif hasattr(value, "to_dict"): 224 | result[attr] = value.to_dict() 225 | elif isinstance(value, dict): 226 | result[attr] = dict(map( 227 | lambda item: (item[0], item[1].to_dict()) 228 | if hasattr(item[1], "to_dict") else item, 229 | value.items() 230 | )) 231 | else: 232 | result[attr] = value 233 | if issubclass(ServiceInformation, dict): 234 | for key, value in self.items(): 235 | result[key] = value 236 | 237 | return result 238 | 239 | def to_str(self): 240 | """Returns the string representation of the model""" 241 | return pprint.pformat(self.to_dict()) 242 | 243 | def __repr__(self): 244 | """For `print` and `pprint`""" 245 | return self.to_str() 246 | 247 | def __eq__(self, other): 248 | """Returns true if both objects are equal""" 249 | if not isinstance(other, ServiceInformation): 250 | return False 251 | 252 | return self.to_dict() == other.to_dict() 253 | 254 | def __ne__(self, other): 255 | """Returns true if both objects are not equal""" 256 | if not isinstance(other, ServiceInformation): 257 | return True 258 | 259 | return self.to_dict() != other.to_dict() 260 | -------------------------------------------------------------------------------- /docusign_click/models/header_styles.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | DocuSign Click API 5 | 6 | Elastic signing (also known as DocuSign Click) lets you capture consent to standard agreement terms with a single click: terms and conditions, terms of service, terms of use, privacy policies, and more. The Click API lets you include this customizable elastic template solution in your DocuSign integrations. # noqa: E501 7 | 8 | OpenAPI spec version: v1 9 | Contact: devcenter@docusign.com 10 | Generated by: https://github.com/swagger-api/swagger-codegen.git 11 | """ 12 | 13 | 14 | import pprint 15 | import re # noqa: F401 16 | 17 | import six 18 | 19 | from docusign_click.client.configuration import Configuration 20 | 21 | 22 | class HeaderStyles(object): 23 | """NOTE: This class is auto generated by the swagger code generator program. 24 | 25 | Do not edit the class manually. 26 | """ 27 | 28 | """ 29 | Attributes: 30 | swagger_types (dict): The key is attribute name 31 | and the value is attribute type. 32 | attribute_map (dict): The key is attribute name 33 | and the value is json key in definition. 34 | """ 35 | swagger_types = { 36 | 'color': 'str', 37 | 'display': 'str', 38 | 'font_family': 'str', 39 | 'font_size': 'str', 40 | 'font_style': 'str', 41 | 'font_weight': 'object', 42 | 'text_decoration': 'str' 43 | } 44 | 45 | attribute_map = { 46 | 'color': 'color', 47 | 'display': 'display', 48 | 'font_family': 'fontFamily', 49 | 'font_size': 'fontSize', 50 | 'font_style': 'fontStyle', 51 | 'font_weight': 'fontWeight', 52 | 'text_decoration': 'textDecoration' 53 | } 54 | 55 | def __init__(self, _configuration=None, **kwargs): # noqa: E501 56 | """HeaderStyles - a model defined in Swagger""" # noqa: E501 57 | if _configuration is None: 58 | _configuration = Configuration() 59 | self._configuration = _configuration 60 | 61 | self._color = None 62 | self._display = None 63 | self._font_family = None 64 | self._font_size = None 65 | self._font_style = None 66 | self._font_weight = None 67 | self._text_decoration = None 68 | self.discriminator = None 69 | 70 | setattr(self, "_{}".format('color'), kwargs.get('color', None)) 71 | setattr(self, "_{}".format('display'), kwargs.get('display', None)) 72 | setattr(self, "_{}".format('font_family'), kwargs.get('font_family', None)) 73 | setattr(self, "_{}".format('font_size'), kwargs.get('font_size', None)) 74 | setattr(self, "_{}".format('font_style'), kwargs.get('font_style', None)) 75 | setattr(self, "_{}".format('font_weight'), kwargs.get('font_weight', None)) 76 | setattr(self, "_{}".format('text_decoration'), kwargs.get('text_decoration', None)) 77 | 78 | @property 79 | def color(self): 80 | """Gets the color of this HeaderStyles. # noqa: E501 81 | 82 | Control the fore-ground color of the element. # noqa: E501 83 | 84 | :return: The color of this HeaderStyles. # noqa: E501 85 | :rtype: str 86 | """ 87 | return self._color 88 | 89 | @color.setter 90 | def color(self, color): 91 | """Sets the color of this HeaderStyles. 92 | 93 | Control the fore-ground color of the element. # noqa: E501 94 | 95 | :param color: The color of this HeaderStyles. # noqa: E501 96 | :type: str 97 | """ 98 | 99 | self._color = color 100 | 101 | @property 102 | def display(self): 103 | """Gets the display of this HeaderStyles. # noqa: E501 104 | 105 | Control the display of the header. Can only be set to 'none' over the default for hiding purposes. # noqa: E501 106 | 107 | :return: The display of this HeaderStyles. # noqa: E501 108 | :rtype: str 109 | """ 110 | return self._display 111 | 112 | @display.setter 113 | def display(self, display): 114 | """Sets the display of this HeaderStyles. 115 | 116 | Control the display of the header. Can only be set to 'none' over the default for hiding purposes. # noqa: E501 117 | 118 | :param display: The display of this HeaderStyles. # noqa: E501 119 | :type: str 120 | """ 121 | allowed_values = ["none"] # noqa: E501 122 | if (self._configuration.client_side_validation and 123 | display not in allowed_values): 124 | raise ValueError( 125 | "Invalid value for `display` ({0}), must be one of {1}" # noqa: E501 126 | .format(display, allowed_values) 127 | ) 128 | 129 | self._display = display 130 | 131 | @property 132 | def font_family(self): 133 | """Gets the font_family of this HeaderStyles. # noqa: E501 134 | 135 | Control the font family of the text. # noqa: E501 136 | 137 | :return: The font_family of this HeaderStyles. # noqa: E501 138 | :rtype: str 139 | """ 140 | return self._font_family 141 | 142 | @font_family.setter 143 | def font_family(self, font_family): 144 | """Sets the font_family of this HeaderStyles. 145 | 146 | Control the font family of the text. # noqa: E501 147 | 148 | :param font_family: The font_family of this HeaderStyles. # noqa: E501 149 | :type: str 150 | """ 151 | 152 | self._font_family = font_family 153 | 154 | @property 155 | def font_size(self): 156 | """Gets the font_size of this HeaderStyles. # noqa: E501 157 | 158 | Control the font size of the text. # noqa: E501 159 | 160 | :return: The font_size of this HeaderStyles. # noqa: E501 161 | :rtype: str 162 | """ 163 | return self._font_size 164 | 165 | @font_size.setter 166 | def font_size(self, font_size): 167 | """Sets the font_size of this HeaderStyles. 168 | 169 | Control the font size of the text. # noqa: E501 170 | 171 | :param font_size: The font_size of this HeaderStyles. # noqa: E501 172 | :type: str 173 | """ 174 | 175 | self._font_size = font_size 176 | 177 | @property 178 | def font_style(self): 179 | """Gets the font_style of this HeaderStyles. # noqa: E501 180 | 181 | Control the font style of the text. # noqa: E501 182 | 183 | :return: The font_style of this HeaderStyles. # noqa: E501 184 | :rtype: str 185 | """ 186 | return self._font_style 187 | 188 | @font_style.setter 189 | def font_style(self, font_style): 190 | """Sets the font_style of this HeaderStyles. 191 | 192 | Control the font style of the text. # noqa: E501 193 | 194 | :param font_style: The font_style of this HeaderStyles. # noqa: E501 195 | :type: str 196 | """ 197 | 198 | self._font_style = font_style 199 | 200 | @property 201 | def font_weight(self): 202 | """Gets the font_weight of this HeaderStyles. # noqa: E501 203 | 204 | Control the font weight of the text. # noqa: E501 205 | 206 | :return: The font_weight of this HeaderStyles. # noqa: E501 207 | :rtype: object 208 | """ 209 | return self._font_weight 210 | 211 | @font_weight.setter 212 | def font_weight(self, font_weight): 213 | """Sets the font_weight of this HeaderStyles. 214 | 215 | Control the font weight of the text. # noqa: E501 216 | 217 | :param font_weight: The font_weight of this HeaderStyles. # noqa: E501 218 | :type: object 219 | """ 220 | 221 | self._font_weight = font_weight 222 | 223 | @property 224 | def text_decoration(self): 225 | """Gets the text_decoration of this HeaderStyles. # noqa: E501 226 | 227 | Control the underline and other styles of the text. # noqa: E501 228 | 229 | :return: The text_decoration of this HeaderStyles. # noqa: E501 230 | :rtype: str 231 | """ 232 | return self._text_decoration 233 | 234 | @text_decoration.setter 235 | def text_decoration(self, text_decoration): 236 | """Sets the text_decoration of this HeaderStyles. 237 | 238 | Control the underline and other styles of the text. # noqa: E501 239 | 240 | :param text_decoration: The text_decoration of this HeaderStyles. # noqa: E501 241 | :type: str 242 | """ 243 | 244 | self._text_decoration = text_decoration 245 | 246 | def to_dict(self): 247 | """Returns the model properties as a dict""" 248 | result = {} 249 | 250 | for attr, _ in six.iteritems(self.swagger_types): 251 | value = getattr(self, attr) 252 | if isinstance(value, list): 253 | result[attr] = list(map( 254 | lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 255 | value 256 | )) 257 | elif hasattr(value, "to_dict"): 258 | result[attr] = value.to_dict() 259 | elif isinstance(value, dict): 260 | result[attr] = dict(map( 261 | lambda item: (item[0], item[1].to_dict()) 262 | if hasattr(item[1], "to_dict") else item, 263 | value.items() 264 | )) 265 | else: 266 | result[attr] = value 267 | if issubclass(HeaderStyles, dict): 268 | for key, value in self.items(): 269 | result[key] = value 270 | 271 | return result 272 | 273 | def to_str(self): 274 | """Returns the string representation of the model""" 275 | return pprint.pformat(self.to_dict()) 276 | 277 | def __repr__(self): 278 | """For `print` and `pprint`""" 279 | return self.to_str() 280 | 281 | def __eq__(self, other): 282 | """Returns true if both objects are equal""" 283 | if not isinstance(other, HeaderStyles): 284 | return False 285 | 286 | return self.to_dict() == other.to_dict() 287 | 288 | def __ne__(self, other): 289 | """Returns true if both objects are not equal""" 290 | if not isinstance(other, HeaderStyles): 291 | return True 292 | 293 | return self.to_dict() != other.to_dict() 294 | -------------------------------------------------------------------------------- /docusign_click/models/clickwrap_versions_paged_response.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | DocuSign Click API 5 | 6 | Elastic signing (also known as DocuSign Click) lets you capture consent to standard agreement terms with a single click: terms and conditions, terms of service, terms of use, privacy policies, and more. The Click API lets you include this customizable elastic template solution in your DocuSign integrations. # noqa: E501 7 | 8 | OpenAPI spec version: v1 9 | Contact: devcenter@docusign.com 10 | Generated by: https://github.com/swagger-api/swagger-codegen.git 11 | """ 12 | 13 | 14 | import pprint 15 | import re # noqa: F401 16 | 17 | import six 18 | 19 | from docusign_click.client.configuration import Configuration 20 | 21 | 22 | class ClickwrapVersionsPagedResponse(object): 23 | """NOTE: This class is auto generated by the swagger code generator program. 24 | 25 | Do not edit the class manually. 26 | """ 27 | 28 | """ 29 | Attributes: 30 | swagger_types (dict): The key is attribute name 31 | and the value is attribute type. 32 | attribute_map (dict): The key is attribute name 33 | and the value is json key in definition. 34 | """ 35 | swagger_types = { 36 | 'account_id': 'str', 37 | 'clickwrap_id': 'str', 38 | 'clickwrap_name': 'str', 39 | 'minimum_pages_remaining': 'int', 40 | 'page': 'int', 41 | 'page_size': 'int', 42 | 'versions': 'list[ClickwrapVersion]' 43 | } 44 | 45 | attribute_map = { 46 | 'account_id': 'accountId', 47 | 'clickwrap_id': 'clickwrapId', 48 | 'clickwrap_name': 'clickwrapName', 49 | 'minimum_pages_remaining': 'minimumPagesRemaining', 50 | 'page': 'page', 51 | 'page_size': 'pageSize', 52 | 'versions': 'versions' 53 | } 54 | 55 | def __init__(self, _configuration=None, **kwargs): # noqa: E501 56 | """ClickwrapVersionsPagedResponse - a model defined in Swagger""" # noqa: E501 57 | if _configuration is None: 58 | _configuration = Configuration() 59 | self._configuration = _configuration 60 | 61 | self._account_id = None 62 | self._clickwrap_id = None 63 | self._clickwrap_name = None 64 | self._minimum_pages_remaining = None 65 | self._page = None 66 | self._page_size = None 67 | self._versions = None 68 | self.discriminator = None 69 | 70 | setattr(self, "_{}".format('account_id'), kwargs.get('account_id', None)) 71 | setattr(self, "_{}".format('clickwrap_id'), kwargs.get('clickwrap_id', None)) 72 | setattr(self, "_{}".format('clickwrap_name'), kwargs.get('clickwrap_name', None)) 73 | setattr(self, "_{}".format('minimum_pages_remaining'), kwargs.get('minimum_pages_remaining', None)) 74 | setattr(self, "_{}".format('page'), kwargs.get('page', None)) 75 | setattr(self, "_{}".format('page_size'), kwargs.get('page_size', None)) 76 | setattr(self, "_{}".format('versions'), kwargs.get('versions', None)) 77 | 78 | @property 79 | def account_id(self): 80 | """Gets the account_id of this ClickwrapVersionsPagedResponse. # noqa: E501 81 | 82 | The external account number (int) or account ID GUID. # noqa: E501 83 | 84 | :return: The account_id of this ClickwrapVersionsPagedResponse. # noqa: E501 85 | :rtype: str 86 | """ 87 | return self._account_id 88 | 89 | @account_id.setter 90 | def account_id(self, account_id): 91 | """Sets the account_id of this ClickwrapVersionsPagedResponse. 92 | 93 | The external account number (int) or account ID GUID. # noqa: E501 94 | 95 | :param account_id: The account_id of this ClickwrapVersionsPagedResponse. # noqa: E501 96 | :type: str 97 | """ 98 | 99 | self._account_id = account_id 100 | 101 | @property 102 | def clickwrap_id(self): 103 | """Gets the clickwrap_id of this ClickwrapVersionsPagedResponse. # noqa: E501 104 | 105 | The ID of the clickwrap. # noqa: E501 106 | 107 | :return: The clickwrap_id of this ClickwrapVersionsPagedResponse. # noqa: E501 108 | :rtype: str 109 | """ 110 | return self._clickwrap_id 111 | 112 | @clickwrap_id.setter 113 | def clickwrap_id(self, clickwrap_id): 114 | """Sets the clickwrap_id of this ClickwrapVersionsPagedResponse. 115 | 116 | The ID of the clickwrap. # noqa: E501 117 | 118 | :param clickwrap_id: The clickwrap_id of this ClickwrapVersionsPagedResponse. # noqa: E501 119 | :type: str 120 | """ 121 | 122 | self._clickwrap_id = clickwrap_id 123 | 124 | @property 125 | def clickwrap_name(self): 126 | """Gets the clickwrap_name of this ClickwrapVersionsPagedResponse. # noqa: E501 127 | 128 | The name of the clickwrap. # noqa: E501 129 | 130 | :return: The clickwrap_name of this ClickwrapVersionsPagedResponse. # noqa: E501 131 | :rtype: str 132 | """ 133 | return self._clickwrap_name 134 | 135 | @clickwrap_name.setter 136 | def clickwrap_name(self, clickwrap_name): 137 | """Sets the clickwrap_name of this ClickwrapVersionsPagedResponse. 138 | 139 | The name of the clickwrap. # noqa: E501 140 | 141 | :param clickwrap_name: The clickwrap_name of this ClickwrapVersionsPagedResponse. # noqa: E501 142 | :type: str 143 | """ 144 | 145 | self._clickwrap_name = clickwrap_name 146 | 147 | @property 148 | def minimum_pages_remaining(self): 149 | """Gets the minimum_pages_remaining of this ClickwrapVersionsPagedResponse. # noqa: E501 150 | 151 | An array of clickwrap versions. # noqa: E501 152 | 153 | :return: The minimum_pages_remaining of this ClickwrapVersionsPagedResponse. # noqa: E501 154 | :rtype: int 155 | """ 156 | return self._minimum_pages_remaining 157 | 158 | @minimum_pages_remaining.setter 159 | def minimum_pages_remaining(self, minimum_pages_remaining): 160 | """Sets the minimum_pages_remaining of this ClickwrapVersionsPagedResponse. 161 | 162 | An array of clickwrap versions. # noqa: E501 163 | 164 | :param minimum_pages_remaining: The minimum_pages_remaining of this ClickwrapVersionsPagedResponse. # noqa: E501 165 | :type: int 166 | """ 167 | 168 | self._minimum_pages_remaining = minimum_pages_remaining 169 | 170 | @property 171 | def page(self): 172 | """Gets the page of this ClickwrapVersionsPagedResponse. # noqa: E501 173 | 174 | The number of the current page. # noqa: E501 175 | 176 | :return: The page of this ClickwrapVersionsPagedResponse. # noqa: E501 177 | :rtype: int 178 | """ 179 | return self._page 180 | 181 | @page.setter 182 | def page(self, page): 183 | """Sets the page of this ClickwrapVersionsPagedResponse. 184 | 185 | The number of the current page. # noqa: E501 186 | 187 | :param page: The page of this ClickwrapVersionsPagedResponse. # noqa: E501 188 | :type: int 189 | """ 190 | 191 | self._page = page 192 | 193 | @property 194 | def page_size(self): 195 | """Gets the page_size of this ClickwrapVersionsPagedResponse. # noqa: E501 196 | 197 | The number of items per page. # noqa: E501 198 | 199 | :return: The page_size of this ClickwrapVersionsPagedResponse. # noqa: E501 200 | :rtype: int 201 | """ 202 | return self._page_size 203 | 204 | @page_size.setter 205 | def page_size(self, page_size): 206 | """Sets the page_size of this ClickwrapVersionsPagedResponse. 207 | 208 | The number of items per page. # noqa: E501 209 | 210 | :param page_size: The page_size of this ClickwrapVersionsPagedResponse. # noqa: E501 211 | :type: int 212 | """ 213 | 214 | self._page_size = page_size 215 | 216 | @property 217 | def versions(self): 218 | """Gets the versions of this ClickwrapVersionsPagedResponse. # noqa: E501 219 | 220 | An array of clickwrap versions. # noqa: E501 221 | 222 | :return: The versions of this ClickwrapVersionsPagedResponse. # noqa: E501 223 | :rtype: list[ClickwrapVersion] 224 | """ 225 | return self._versions 226 | 227 | @versions.setter 228 | def versions(self, versions): 229 | """Sets the versions of this ClickwrapVersionsPagedResponse. 230 | 231 | An array of clickwrap versions. # noqa: E501 232 | 233 | :param versions: The versions of this ClickwrapVersionsPagedResponse. # noqa: E501 234 | :type: list[ClickwrapVersion] 235 | """ 236 | 237 | self._versions = versions 238 | 239 | def to_dict(self): 240 | """Returns the model properties as a dict""" 241 | result = {} 242 | 243 | for attr, _ in six.iteritems(self.swagger_types): 244 | value = getattr(self, attr) 245 | if isinstance(value, list): 246 | result[attr] = list(map( 247 | lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 248 | value 249 | )) 250 | elif hasattr(value, "to_dict"): 251 | result[attr] = value.to_dict() 252 | elif isinstance(value, dict): 253 | result[attr] = dict(map( 254 | lambda item: (item[0], item[1].to_dict()) 255 | if hasattr(item[1], "to_dict") else item, 256 | value.items() 257 | )) 258 | else: 259 | result[attr] = value 260 | if issubclass(ClickwrapVersionsPagedResponse, dict): 261 | for key, value in self.items(): 262 | result[key] = value 263 | 264 | return result 265 | 266 | def to_str(self): 267 | """Returns the string representation of the model""" 268 | return pprint.pformat(self.to_dict()) 269 | 270 | def __repr__(self): 271 | """For `print` and `pprint`""" 272 | return self.to_str() 273 | 274 | def __eq__(self, other): 275 | """Returns true if both objects are equal""" 276 | if not isinstance(other, ClickwrapVersionsPagedResponse): 277 | return False 278 | 279 | return self.to_dict() == other.to_dict() 280 | 281 | def __ne__(self, other): 282 | """Returns true if both objects are not equal""" 283 | if not isinstance(other, ClickwrapVersionsPagedResponse): 284 | return True 285 | 286 | return self.to_dict() != other.to_dict() 287 | -------------------------------------------------------------------------------- /docusign_click/models/document.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | DocuSign Click API 5 | 6 | Elastic signing (also known as DocuSign Click) lets you capture consent to standard agreement terms with a single click: terms and conditions, terms of service, terms of use, privacy policies, and more. The Click API lets you include this customizable elastic template solution in your DocuSign integrations. # noqa: E501 7 | 8 | OpenAPI spec version: v1 9 | Contact: devcenter@docusign.com 10 | Generated by: https://github.com/swagger-api/swagger-codegen.git 11 | """ 12 | 13 | 14 | import pprint 15 | import re # noqa: F401 16 | 17 | import six 18 | 19 | from docusign_click.client.configuration import Configuration 20 | 21 | 22 | class Document(object): 23 | """NOTE: This class is auto generated by the swagger code generator program. 24 | 25 | Do not edit the class manually. 26 | """ 27 | 28 | """ 29 | Attributes: 30 | swagger_types (dict): The key is attribute name 31 | and the value is attribute type. 32 | attribute_map (dict): The key is attribute name 33 | and the value is json key in definition. 34 | """ 35 | swagger_types = { 36 | 'document_base64': 'str', 37 | 'document_display': 'str', 38 | 'document_html': 'str', 39 | 'document_name': 'str', 40 | 'file_extension': 'str', 41 | 'must_read': 'bool', 42 | 'must_view': 'bool', 43 | 'order': 'int' 44 | } 45 | 46 | attribute_map = { 47 | 'document_base64': 'documentBase64', 48 | 'document_display': 'documentDisplay', 49 | 'document_html': 'documentHtml', 50 | 'document_name': 'documentName', 51 | 'file_extension': 'fileExtension', 52 | 'must_read': 'mustRead', 53 | 'must_view': 'mustView', 54 | 'order': 'order' 55 | } 56 | 57 | def __init__(self, _configuration=None, **kwargs): # noqa: E501 58 | """Document - a model defined in Swagger""" # noqa: E501 59 | if _configuration is None: 60 | _configuration = Configuration() 61 | self._configuration = _configuration 62 | 63 | self._document_base64 = None 64 | self._document_display = None 65 | self._document_html = None 66 | self._document_name = None 67 | self._file_extension = None 68 | self._must_read = None 69 | self._must_view = None 70 | self._order = None 71 | self.discriminator = None 72 | 73 | setattr(self, "_{}".format('document_base64'), kwargs.get('document_base64', None)) 74 | setattr(self, "_{}".format('document_display'), kwargs.get('document_display', None)) 75 | setattr(self, "_{}".format('document_html'), kwargs.get('document_html', None)) 76 | setattr(self, "_{}".format('document_name'), kwargs.get('document_name', None)) 77 | setattr(self, "_{}".format('file_extension'), kwargs.get('file_extension', None)) 78 | setattr(self, "_{}".format('must_read'), kwargs.get('must_read', None)) 79 | setattr(self, "_{}".format('must_view'), kwargs.get('must_view', None)) 80 | setattr(self, "_{}".format('order'), kwargs.get('order', None)) 81 | 82 | @property 83 | def document_base64(self): 84 | """Gets the document_base64 of this Document. # noqa: E501 85 | 86 | The base64-encoded contents of the document. # noqa: E501 87 | 88 | :return: The document_base64 of this Document. # noqa: E501 89 | :rtype: str 90 | """ 91 | return self._document_base64 92 | 93 | @document_base64.setter 94 | def document_base64(self, document_base64): 95 | """Sets the document_base64 of this Document. 96 | 97 | The base64-encoded contents of the document. # noqa: E501 98 | 99 | :param document_base64: The document_base64 of this Document. # noqa: E501 100 | :type: str 101 | """ 102 | 103 | self._document_base64 = document_base64 104 | 105 | @property 106 | def document_display(self): 107 | """Gets the document_display of this Document. # noqa: E501 108 | 109 | Display type: link, document or pdf # noqa: E501 110 | 111 | :return: The document_display of this Document. # noqa: E501 112 | :rtype: str 113 | """ 114 | return self._document_display 115 | 116 | @document_display.setter 117 | def document_display(self, document_display): 118 | """Sets the document_display of this Document. 119 | 120 | Display type: link, document or pdf # noqa: E501 121 | 122 | :param document_display: The document_display of this Document. # noqa: E501 123 | :type: str 124 | """ 125 | 126 | self._document_display = document_display 127 | 128 | @property 129 | def document_html(self): 130 | """Gets the document_html of this Document. # noqa: E501 131 | 132 | The HTML representation of the document. # noqa: E501 133 | 134 | :return: The document_html of this Document. # noqa: E501 135 | :rtype: str 136 | """ 137 | return self._document_html 138 | 139 | @document_html.setter 140 | def document_html(self, document_html): 141 | """Sets the document_html of this Document. 142 | 143 | The HTML representation of the document. # noqa: E501 144 | 145 | :param document_html: The document_html of this Document. # noqa: E501 146 | :type: str 147 | """ 148 | 149 | self._document_html = document_html 150 | 151 | @property 152 | def document_name(self): 153 | """Gets the document_name of this Document. # noqa: E501 154 | 155 | The name of the document. # noqa: E501 156 | 157 | :return: The document_name of this Document. # noqa: E501 158 | :rtype: str 159 | """ 160 | return self._document_name 161 | 162 | @document_name.setter 163 | def document_name(self, document_name): 164 | """Sets the document_name of this Document. 165 | 166 | The name of the document. # noqa: E501 167 | 168 | :param document_name: The document_name of this Document. # noqa: E501 169 | :type: str 170 | """ 171 | 172 | self._document_name = document_name 173 | 174 | @property 175 | def file_extension(self): 176 | """Gets the file_extension of this Document. # noqa: E501 177 | 178 | The file extension of the document. # noqa: E501 179 | 180 | :return: The file_extension of this Document. # noqa: E501 181 | :rtype: str 182 | """ 183 | return self._file_extension 184 | 185 | @file_extension.setter 186 | def file_extension(self, file_extension): 187 | """Sets the file_extension of this Document. 188 | 189 | The file extension of the document. # noqa: E501 190 | 191 | :param file_extension: The file_extension of this Document. # noqa: E501 192 | :type: str 193 | """ 194 | 195 | self._file_extension = file_extension 196 | 197 | @property 198 | def must_read(self): 199 | """Gets the must_read of this Document. # noqa: E501 200 | 201 | **True** if the user needs to scroll to the end of the document. # noqa: E501 202 | 203 | :return: The must_read of this Document. # noqa: E501 204 | :rtype: bool 205 | """ 206 | return self._must_read 207 | 208 | @must_read.setter 209 | def must_read(self, must_read): 210 | """Sets the must_read of this Document. 211 | 212 | **True** if the user needs to scroll to the end of the document. # noqa: E501 213 | 214 | :param must_read: The must_read of this Document. # noqa: E501 215 | :type: bool 216 | """ 217 | 218 | self._must_read = must_read 219 | 220 | @property 221 | def must_view(self): 222 | """Gets the must_view of this Document. # noqa: E501 223 | 224 | **True** if the user must view the document. # noqa: E501 225 | 226 | :return: The must_view of this Document. # noqa: E501 227 | :rtype: bool 228 | """ 229 | return self._must_view 230 | 231 | @must_view.setter 232 | def must_view(self, must_view): 233 | """Sets the must_view of this Document. 234 | 235 | **True** if the user must view the document. # noqa: E501 236 | 237 | :param must_view: The must_view of this Document. # noqa: E501 238 | :type: bool 239 | """ 240 | 241 | self._must_view = must_view 242 | 243 | @property 244 | def order(self): 245 | """Gets the order of this Document. # noqa: E501 246 | 247 | The order of document layout. # noqa: E501 248 | 249 | :return: The order of this Document. # noqa: E501 250 | :rtype: int 251 | """ 252 | return self._order 253 | 254 | @order.setter 255 | def order(self, order): 256 | """Sets the order of this Document. 257 | 258 | The order of document layout. # noqa: E501 259 | 260 | :param order: The order of this Document. # noqa: E501 261 | :type: int 262 | """ 263 | 264 | self._order = order 265 | 266 | def to_dict(self): 267 | """Returns the model properties as a dict""" 268 | result = {} 269 | 270 | for attr, _ in six.iteritems(self.swagger_types): 271 | value = getattr(self, attr) 272 | if isinstance(value, list): 273 | result[attr] = list(map( 274 | lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 275 | value 276 | )) 277 | elif hasattr(value, "to_dict"): 278 | result[attr] = value.to_dict() 279 | elif isinstance(value, dict): 280 | result[attr] = dict(map( 281 | lambda item: (item[0], item[1].to_dict()) 282 | if hasattr(item[1], "to_dict") else item, 283 | value.items() 284 | )) 285 | else: 286 | result[attr] = value 287 | if issubclass(Document, dict): 288 | for key, value in self.items(): 289 | result[key] = value 290 | 291 | return result 292 | 293 | def to_str(self): 294 | """Returns the string representation of the model""" 295 | return pprint.pformat(self.to_dict()) 296 | 297 | def __repr__(self): 298 | """For `print` and `pprint`""" 299 | return self.to_str() 300 | 301 | def __eq__(self, other): 302 | """Returns true if both objects are equal""" 303 | if not isinstance(other, Document): 304 | return False 305 | 306 | return self.to_dict() == other.to_dict() 307 | 308 | def __ne__(self, other): 309 | """Returns true if both objects are not equal""" 310 | if not isinstance(other, Document): 311 | return True 312 | 313 | return self.to_dict() != other.to_dict() 314 | --------------------------------------------------------------------------------