diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES index 6f128a6..22b6473 100644 --- a/.openapi-generator/FILES +++ b/.openapi-generator/FILES @@ -9,6 +9,7 @@ docs/AccountCreateResponse.md docs/AccountGetResponse.md docs/AccountResponse.md docs/AccountResponseQuotas.md +docs/AccountResponseUsage.md docs/AccountUpdateRequest.md docs/AccountVerifyRequest.md docs/AccountVerifyResponse.md @@ -207,6 +208,7 @@ dropbox_sign/model/account_create_response.py dropbox_sign/model/account_get_response.py dropbox_sign/model/account_response.py dropbox_sign/model/account_response_quotas.py +dropbox_sign/model/account_response_usage.py dropbox_sign/model/account_update_request.py dropbox_sign/model/account_verify_request.py dropbox_sign/model/account_verify_response.py diff --git a/README.md b/README.md index c716660..eb3192e 100644 --- a/README.md +++ b/README.md @@ -50,7 +50,7 @@ Python >=3.7 Install using `pip`: ```shell -python3 -m pip install dropbox-sign==1.4.2 +python3 -m pip install dropbox-sign==1.5.0 ``` Alternatively: @@ -171,6 +171,7 @@ All URIs are relative to *https://api.hellosign.com/v3* - [AccountGetResponse](docs/AccountGetResponse.md) - [AccountResponse](docs/AccountResponse.md) - [AccountResponseQuotas](docs/AccountResponseQuotas.md) + - [AccountResponseUsage](docs/AccountResponseUsage.md) - [AccountUpdateRequest](docs/AccountUpdateRequest.md) - [AccountVerifyRequest](docs/AccountVerifyRequest.md) - [AccountVerifyResponse](docs/AccountVerifyResponse.md) @@ -362,6 +363,6 @@ apisupport@hellosign.com This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: - API version: 3.0.0 -- Package version: 1.4.2 +- Package version: 1.5.0 - Build package: org.openapitools.codegen.languages.PythonClientCodegen diff --git a/VERSION b/VERSION index 9df886c..bc80560 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -1.4.2 +1.5.0 diff --git a/docs/AccountResponse.md b/docs/AccountResponse.md index 0dc03f3..cf55526 100644 --- a/docs/AccountResponse.md +++ b/docs/AccountResponse.md @@ -16,6 +16,7 @@ | `role_code` | ```str, none_type``` | The membership role for the team. | | | `team_id` | ```str, none_type``` | The id of the team account belongs to. | | | `locale` | ```str, none_type``` | The locale used in this Account. Check out the list of [supported locales](/api/reference/constants/#supported-locales) to learn more about the possible values. | | +| `usage` | [```AccountResponseUsage```](AccountResponseUsage.md) | | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/AccountResponseQuotas.md b/docs/AccountResponseQuotas.md index 61fb0ce..bdf6974 100644 --- a/docs/AccountResponseQuotas.md +++ b/docs/AccountResponseQuotas.md @@ -11,6 +11,7 @@ Details concerning remaining monthly quotas. | `templates_total` | ```int, none_type``` | Total API templates allowed. | | | `templates_left` | ```int, none_type``` | API templates remaining. | | | `sms_verifications_left` | ```int, none_type``` | SMS verifications remaining. | | +| `num_fax_pages_left` | ```int, none_type``` | Number of fax pages left | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/AccountResponseUsage.md b/docs/AccountResponseUsage.md new file mode 100644 index 0000000..e6e51d2 --- /dev/null +++ b/docs/AccountResponseUsage.md @@ -0,0 +1,14 @@ +# AccountResponseUsage + +Details concerning monthly usage + +## Properties + +| Name | Type | Description | Notes | +| ---- | ---- | ----------- | ----- | +| `fax_pages_sent` | ```int, none_type``` | Number of fax pages sent | | + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/dropbox_sign/__init__.py b/dropbox_sign/__init__.py index 53e65f3..b698801 100644 --- a/dropbox_sign/__init__.py +++ b/dropbox_sign/__init__.py @@ -11,7 +11,7 @@ """ -__version__ = "1.4.2" +__version__ = "1.5.0" # import ApiClient from dropbox_sign.api_client import ApiClient diff --git a/dropbox_sign/api_client.py b/dropbox_sign/api_client.py index 3ccd0ef..67b3f08 100644 --- a/dropbox_sign/api_client.py +++ b/dropbox_sign/api_client.py @@ -77,7 +77,7 @@ def __init__(self, configuration=None, header_name=None, header_value=None, self.default_headers[header_name] = header_value self.cookie = cookie # Set default User-Agent. - self.user_agent = 'OpenAPI-Generator/1.4.2/python' + self.user_agent = 'OpenAPI-Generator/1.5.0/python' def __enter__(self): return self diff --git a/dropbox_sign/configuration.py b/dropbox_sign/configuration.py index 6c49dbf..7f8833e 100644 --- a/dropbox_sign/configuration.py +++ b/dropbox_sign/configuration.py @@ -413,7 +413,7 @@ def to_debug_report(self): "OS: {env}\n"\ "Python Version: {pyversion}\n"\ "Version of the API: 3.0.0\n"\ - "SDK Package Version: 1.4.2".\ + "SDK Package Version: 1.5.0".\ format(env=sys.platform, pyversion=sys.version) def get_host_settings(self): diff --git a/dropbox_sign/model/account_response.py b/dropbox_sign/model/account_response.py index 92d2e5c..3c35e63 100644 --- a/dropbox_sign/model/account_response.py +++ b/dropbox_sign/model/account_response.py @@ -34,11 +34,14 @@ from dropbox_sign.exceptions import ApiAttributeError if TYPE_CHECKING: from dropbox_sign.model.account_response_quotas import AccountResponseQuotas + from dropbox_sign.model.account_response_usage import AccountResponseUsage def lazy_import(): from dropbox_sign.model.account_response_quotas import AccountResponseQuotas + from dropbox_sign.model.account_response_usage import AccountResponseUsage globals()['AccountResponseQuotas'] = AccountResponseQuotas + globals()['AccountResponseUsage'] = AccountResponseUsage class AccountResponse(ModelNormal): @@ -104,6 +107,7 @@ def openapi_types(): 'role_code': (str, none_type,), # noqa: E501 'team_id': (str, none_type,), # noqa: E501 'locale': (str, none_type,), # noqa: E501 + 'usage': (AccountResponseUsage,), # noqa: E501 } @cached_property @@ -137,6 +141,7 @@ def init(data: any) -> AccountResponse: 'role_code': 'role_code', # noqa: E501 'team_id': 'team_id', # noqa: E501 'locale': 'locale', # noqa: E501 + 'usage': 'usage', # noqa: E501 } read_only_vars = { @@ -224,6 +229,14 @@ def locale(self) -> Optional[str]: def locale(self, value: Optional[str]): setattr(self, "locale", value) + @property + def usage(self) -> AccountResponseUsage: + return self.get("usage") + + @usage.setter + def usage(self, value: AccountResponseUsage): + setattr(self, "usage", value) + @classmethod @convert_js_args_to_python_args def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 @@ -270,6 +283,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 role_code (str, none_type): The membership role for the team.. [optional] # noqa: E501 team_id (str, none_type): The id of the team account belongs to.. [optional] # noqa: E501 locale (str, none_type): The locale used in this Account. Check out the list of [supported locales](/api/reference/constants/#supported-locales) to learn more about the possible values.. [optional] # noqa: E501 + usage (AccountResponseUsage): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -361,6 +375,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 role_code (str, none_type): The membership role for the team.. [optional] # noqa: E501 team_id (str, none_type): The id of the team account belongs to.. [optional] # noqa: E501 locale (str, none_type): The locale used in this Account. Check out the list of [supported locales](/api/reference/constants/#supported-locales) to learn more about the possible values.. [optional] # noqa: E501 + usage (AccountResponseUsage): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/dropbox_sign/model/account_response_quotas.py b/dropbox_sign/model/account_response_quotas.py index 1eccd28..a38ffcc 100644 --- a/dropbox_sign/model/account_response_quotas.py +++ b/dropbox_sign/model/account_response_quotas.py @@ -91,6 +91,7 @@ def openapi_types(): 'templates_total': (int, none_type,), # noqa: E501 'templates_left': (int, none_type,), # noqa: E501 'sms_verifications_left': (int, none_type,), # noqa: E501 + 'num_fax_pages_left': (int, none_type,), # noqa: E501 } @cached_property @@ -119,6 +120,7 @@ def init(data: any) -> AccountResponseQuotas: 'templates_total': 'templates_total', # noqa: E501 'templates_left': 'templates_left', # noqa: E501 'sms_verifications_left': 'sms_verifications_left', # noqa: E501 + 'num_fax_pages_left': 'num_fax_pages_left', # noqa: E501 } read_only_vars = { @@ -166,6 +168,14 @@ def sms_verifications_left(self) -> Optional[int]: def sms_verifications_left(self, value: Optional[int]): setattr(self, "sms_verifications_left", value) + @property + def num_fax_pages_left(self) -> Optional[int]: + return self.get("num_fax_pages_left") + + @num_fax_pages_left.setter + def num_fax_pages_left(self, value: Optional[int]): + setattr(self, "num_fax_pages_left", value) + @classmethod @convert_js_args_to_python_args def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 @@ -207,6 +217,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 templates_total (int, none_type): Total API templates allowed.. [optional] # noqa: E501 templates_left (int, none_type): API templates remaining.. [optional] # noqa: E501 sms_verifications_left (int, none_type): SMS verifications remaining.. [optional] # noqa: E501 + num_fax_pages_left (int, none_type): Number of fax pages left. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -293,6 +304,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 templates_total (int, none_type): Total API templates allowed.. [optional] # noqa: E501 templates_left (int, none_type): API templates remaining.. [optional] # noqa: E501 sms_verifications_left (int, none_type): SMS verifications remaining.. [optional] # noqa: E501 + num_fax_pages_left (int, none_type): Number of fax pages left. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/dropbox_sign/model/account_response_usage.py b/dropbox_sign/model/account_response_usage.py new file mode 100644 index 0000000..8bdf363 --- /dev/null +++ b/dropbox_sign/model/account_response_usage.py @@ -0,0 +1,283 @@ +""" + Dropbox Sign API + + Dropbox Sign v3 API # noqa: E501 + + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by: https://openapi-generator.tech +""" + + +from __future__ import annotations +from typing import TYPE_CHECKING, Optional, List, Dict, Union +import json # noqa: F401 +import re # noqa: F401 +import sys # noqa: F401 + +from dropbox_sign import ApiClient +from dropbox_sign.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from dropbox_sign.exceptions import ApiAttributeError + + + +class AccountResponseUsage(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'fax_pages_sent': (int, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + @staticmethod + def init(data: any) -> AccountResponseUsage: + """ + Attempt to instantiate and hydrate a new instance of this class + """ + try: + obj_data = json.dumps(data) + except TypeError: + obj_data = data + + return ApiClient().deserialize( + response=type('obj_dict', (object,), {'data': obj_data}), + response_type=[AccountResponseUsage], + _check_type=True, + ) + + attribute_map = { + 'fax_pages_sent': 'fax_pages_sent', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @property + def fax_pages_sent(self) -> Optional[int]: + return self.get("fax_pages_sent") + + @fax_pages_sent.setter + def fax_pages_sent(self, value: Optional[int]): + setattr(self, "fax_pages_sent", value) + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """AccountResponseUsage - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + fax_pages_sent (int, none_type): Number of fax pages sent. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """AccountResponseUsage - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + fax_pages_sent (int, none_type): Number of fax pages sent. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/dropbox_sign/models/__init__.py b/dropbox_sign/models/__init__.py index cc37e87..81a97b0 100644 --- a/dropbox_sign/models/__init__.py +++ b/dropbox_sign/models/__init__.py @@ -14,6 +14,7 @@ from dropbox_sign.model.account_get_response import AccountGetResponse from dropbox_sign.model.account_response import AccountResponse from dropbox_sign.model.account_response_quotas import AccountResponseQuotas +from dropbox_sign.model.account_response_usage import AccountResponseUsage from dropbox_sign.model.account_update_request import AccountUpdateRequest from dropbox_sign.model.account_verify_request import AccountVerifyRequest from dropbox_sign.model.account_verify_response import AccountVerifyResponse diff --git a/openapi-config.yaml b/openapi-config.yaml index 5d0e404..6e10988 100644 --- a/openapi-config.yaml +++ b/openapi-config.yaml @@ -4,7 +4,7 @@ additionalProperties: generatorLanguageVersion: ">=3.7" packageName: dropbox_sign projectName: dropbox-sign - packageVersion: 1.4.2 + packageVersion: 1.5.0 sortModelPropertiesByRequiredFlag: true legacyDiscriminatorBehavior: true packageAuthor: Dropbox Sign API Team diff --git a/openapi-sdk.yaml b/openapi-sdk.yaml index 6a2f61a..9bf5a68 100644 --- a/openapi-sdk.yaml +++ b/openapi-sdk.yaml @@ -7918,7 +7918,7 @@ components: initials: '#/components/schemas/SubFormFieldsPerDocumentInitials' text-merge: '#/components/schemas/SubFormFieldsPerDocumentTextMerge' checkbox-merge: '#/components/schemas/SubFormFieldsPerDocumentCheckboxMerge' - x-internal: true + x-internal-class: true x-base-class: true SubSignatureRequestGroupedSigners: required: @@ -9129,7 +9129,7 @@ components: items: $ref: '#/components/schemas/WarningResponse' type: object - x-internal: true + x-internal-class: true AccountGetResponse: properties: account: @@ -9140,7 +9140,7 @@ components: items: $ref: '#/components/schemas/WarningResponse' type: object - x-internal: true + x-internal-class: true AccountVerifyResponse: properties: account: @@ -9151,7 +9151,7 @@ components: items: $ref: '#/components/schemas/WarningResponse' type: object - x-internal: true + x-internal-class: true ApiAppGetResponse: properties: api_app: @@ -9162,7 +9162,7 @@ components: items: $ref: '#/components/schemas/WarningResponse' type: object - x-internal: true + x-internal-class: true ApiAppListResponse: properties: api_apps: @@ -9178,7 +9178,7 @@ components: items: $ref: '#/components/schemas/WarningResponse' type: object - x-internal: true + x-internal-class: true BulkSendJobGetResponse: properties: bulk_send_job: @@ -9196,7 +9196,7 @@ components: items: $ref: '#/components/schemas/WarningResponse' type: object - x-internal: true + x-internal-class: true BulkSendJobListResponse: properties: bulk_send_jobs: @@ -9212,7 +9212,7 @@ components: items: $ref: '#/components/schemas/WarningResponse' type: object - x-internal: true + x-internal-class: true BulkSendJobSendResponse: properties: bulk_send_job: @@ -9223,7 +9223,7 @@ components: items: $ref: '#/components/schemas/WarningResponse' type: object - x-internal: true + x-internal-class: true EmbeddedEditUrlResponse: properties: embedded: @@ -9234,7 +9234,7 @@ components: items: $ref: '#/components/schemas/WarningResponse' type: object - x-internal: true + x-internal-class: true EmbeddedSignUrlResponse: properties: embedded: @@ -9245,7 +9245,7 @@ components: items: $ref: '#/components/schemas/WarningResponse' type: object - x-internal: true + x-internal-class: true ErrorResponse: required: - error @@ -9262,14 +9262,14 @@ components: description: 'When the link expires.' type: integer type: object - x-internal: true + x-internal-class: true FileResponseDataUri: properties: data_uri: description: 'File as base64 encoded string.' type: string type: object - x-internal: true + x-internal-class: true ReportCreateResponse: properties: report: @@ -9280,7 +9280,7 @@ components: items: $ref: '#/components/schemas/WarningResponse' type: object - x-internal: true + x-internal-class: true SignatureRequestGetResponse: properties: signature_request: @@ -9291,7 +9291,7 @@ components: items: $ref: '#/components/schemas/WarningResponse' type: object - x-internal: true + x-internal-class: true SignatureRequestListResponse: properties: signature_requests: @@ -9307,7 +9307,7 @@ components: items: $ref: '#/components/schemas/WarningResponse' type: object - x-internal: true + x-internal-class: true AccountResponse: properties: account_id: @@ -9343,8 +9343,10 @@ components: description: 'The locale used in this Account. Check out the list of [supported locales](/api/reference/constants/#supported-locales) to learn more about the possible values.' type: string nullable: true + usage: + $ref: '#/components/schemas/AccountResponseUsage' type: object - x-internal: true + x-internal-class: true OAuthTokenResponse: properties: access_token: @@ -9360,7 +9362,7 @@ components: type: string nullable: true type: object - x-internal: true + x-internal-class: true AccountResponseQuotas: description: 'Details concerning remaining monthly quotas.' properties: @@ -9384,15 +9386,28 @@ components: description: 'SMS verifications remaining.' type: integer nullable: true + num_fax_pages_left: + description: 'Number of fax pages left' + type: integer + nullable: true + type: object + x-internal-class: true + AccountResponseUsage: + description: 'Details concerning monthly usage' + properties: + fax_pages_sent: + description: 'Number of fax pages sent' + type: integer + nullable: true type: object - x-internal: true + x-internal-class: true AccountVerifyResponseAccount: properties: email_address: description: 'The email address associated with the Account.' type: string type: object - x-internal: true + x-internal-class: true ApiAppResponse: description: 'Contains information about an API App.' properties: @@ -9426,7 +9441,7 @@ components: white_labeling_options: $ref: '#/components/schemas/ApiAppResponseWhiteLabelingOptions' type: object - x-internal: true + x-internal-class: true ApiAppResponseOAuth: description: 'An object describing the app''s OAuth properties, or null if OAuth is not configured for the app.' properties: @@ -9446,7 +9461,7 @@ components: type: boolean type: object nullable: true - x-internal: true + x-internal-class: true ApiAppResponseOptions: description: 'An object with options that override account settings.' properties: @@ -9455,7 +9470,7 @@ components: type: boolean type: object nullable: true - x-internal: true + x-internal-class: true ApiAppResponseOwnerAccount: description: 'An object describing the app''s owner' properties: @@ -9466,7 +9481,7 @@ components: description: 'The owner account''s email address' type: string type: object - x-internal: true + x-internal-class: true ApiAppResponseWhiteLabelingOptions: description: 'An object with options to customize the app''s signer page' properties: @@ -9500,7 +9515,7 @@ components: type: string type: object nullable: true - x-internal: true + x-internal-class: true BulkSendJobResponse: description: 'Contains information about the BulkSendJob such as when it was created and how many signature requests are queued.' properties: @@ -9518,7 +9533,7 @@ components: description: 'Time that the BulkSendJob was created.' type: integer type: object - x-internal: true + x-internal-class: true BulkSendJobGetResponseSignatureRequests: title: BulkSendJobGetResponseSignatureRequests type: object @@ -9530,7 +9545,7 @@ components: bulk_send_job_id: description: 'The id of the BulkSendJob.' type: string - x-internal: true + x-internal-class: true EmbeddedEditUrlResponseEmbedded: description: 'An embedded template object.' properties: @@ -9541,7 +9556,7 @@ components: description: 'The specific time that the the `edit_url` link expires, in epoch.' type: integer type: object - x-internal: true + x-internal-class: true EmbeddedSignUrlResponseEmbedded: description: 'An object that contains necessary information to set up embedded signing.' properties: @@ -9552,7 +9567,7 @@ components: description: 'The specific time that the the `sign_url` link expires, in epoch.' type: integer type: object - x-internal: true + x-internal-class: true ErrorResponseError: description: 'Contains information about an error that occurred.' required: @@ -9586,7 +9601,7 @@ components: description: 'Objects returned per page.' type: integer type: object - x-internal: true + x-internal-class: true ReportResponse: description: 'Contains information about the report request.' properties: @@ -9607,7 +9622,7 @@ components: - user_activity - document_status type: object - x-internal: true + x-internal-class: true SignatureRequestResponse: description: 'Contains information about a signature request.' properties: @@ -9715,7 +9730,7 @@ components: type: string nullable: true type: object - x-internal: true + x-internal-class: true SignatureRequestResponseAttachment: description: 'Signer attachments.' required: @@ -9745,7 +9760,7 @@ components: type: integer nullable: true type: object - x-internal: true + x-internal-class: true SignatureRequestResponseCustomFieldBase: description: |- An array of Custom Field objects containing the name and type of each custom field. @@ -9777,7 +9792,7 @@ components: mapping: text: '#/components/schemas/SignatureRequestResponseCustomFieldText' checkbox: '#/components/schemas/SignatureRequestResponseCustomFieldCheckbox' - x-internal: true + x-internal-class: true x-base-class: true SignatureRequestResponseCustomFieldCheckbox: description: 'This class extends `SignatureRequestResponseCustomFieldBase`.' @@ -9850,7 +9865,7 @@ components: initials: '#/components/schemas/SignatureRequestResponseDataValueInitials' text-merge: '#/components/schemas/SignatureRequestResponseDataValueTextMerge' checkbox-merge: '#/components/schemas/SignatureRequestResponseDataValueCheckboxMerge' - x-internal: true + x-internal-class: true x-base-class: true SignatureRequestResponseDataTypeEnum: type: string @@ -10066,7 +10081,7 @@ components: type: string nullable: true type: object - x-internal: true + x-internal-class: true TeamResponse: description: 'Contains information about your team and its members' properties: @@ -10088,7 +10103,7 @@ components: items: type: string type: object - x-internal: true + x-internal-class: true TeamInfoResponse: properties: team_id: @@ -10106,7 +10121,7 @@ components: description: 'Number of sub teams within a team' type: integer type: object - x-internal: true + x-internal-class: true TeamInviteResponse: properties: email_address: @@ -10128,7 +10143,7 @@ components: description: 'Timestamp when the invitation is expiring.' type: integer type: object - x-internal: true + x-internal-class: true TeamMemberResponse: properties: account_id: @@ -10141,7 +10156,7 @@ components: description: 'The specific role a member has on the team.' type: string type: object - x-internal: true + x-internal-class: true TeamParentResponse: description: 'Information about the parent team if a team has one, set to `null` otherwise.' properties: @@ -10153,7 +10168,7 @@ components: type: string type: object nullable: true - x-internal: true + x-internal-class: true SubTeamResponse: properties: team_id: @@ -10163,7 +10178,7 @@ components: description: 'The name of a team' type: string type: object - x-internal: true + x-internal-class: true TemplateResponse: description: 'Contains information about the templates you and your team have created.' properties: @@ -10237,7 +10252,7 @@ components: $ref: '#/components/schemas/TemplateResponseAccount' nullable: true type: object - x-internal: true + x-internal-class: true TemplateResponseAccount: properties: account_id: @@ -10258,7 +10273,7 @@ components: quotas: $ref: '#/components/schemas/TemplateResponseAccountQuota' type: object - x-internal: true + x-internal-class: true TemplateResponseAccountQuota: description: 'An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template.' properties: @@ -10275,14 +10290,14 @@ components: description: 'SMS verifications remaining.' type: integer type: object - x-internal: true + x-internal-class: true TemplateResponseCCRole: properties: name: description: 'The name of the Role.' type: string type: object - x-internal: true + x-internal-class: true TemplateCreateEmbeddedDraftResponseTemplate: description: 'Template object with parameters: `template_id`, `edit_url`, `expires_at`.' properties: @@ -10302,7 +10317,7 @@ components: $ref: '#/components/schemas/WarningResponse' deprecated: true type: object - x-internal: true + x-internal-class: true TemplateCreateResponseTemplate: description: 'Template object with parameters: `template_id`.' properties: @@ -10310,7 +10325,7 @@ components: description: 'The id of the Template.' type: string type: object - x-internal: true + x-internal-class: true TemplateResponseDocument: properties: name: @@ -10341,7 +10356,7 @@ components: $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase' nullable: true type: object - x-internal: true + x-internal-class: true TemplateResponseDocumentCustomFieldBase: description: 'An array of Form Field objects containing the name and type of each named field.' required: @@ -10384,7 +10399,7 @@ components: mapping: text: '#/components/schemas/TemplateResponseDocumentCustomFieldText' checkbox: '#/components/schemas/TemplateResponseDocumentCustomFieldCheckbox' - x-internal: true + x-internal-class: true x-base-class: true TemplateResponseDocumentCustomFieldCheckbox: description: 'This class extends `TemplateResponseDocumentCustomFieldBase`' @@ -10441,7 +10456,7 @@ components: rule: $ref: '#/components/schemas/TemplateResponseDocumentFieldGroupRule' type: object - x-internal: true + x-internal-class: true TemplateResponseDocumentFieldGroupRule: description: 'The rule used to validate checkboxes in the form field group. See [checkbox field grouping](/api/reference/constants/#checkbox-field-grouping).' properties: @@ -10457,7 +10472,7 @@ components: description: 'Name of the group' type: string type: object - x-internal: true + x-internal-class: true TemplateResponseDocumentFormFieldBase: description: 'An array of Form Field objects containing the name and type of each named field.' required: @@ -10505,7 +10520,7 @@ components: signature: '#/components/schemas/TemplateResponseDocumentFormFieldSignature' date_signed: '#/components/schemas/TemplateResponseDocumentFormFieldDateSigned' initials: '#/components/schemas/TemplateResponseDocumentFormFieldInitials' - x-internal: true + x-internal-class: true x-base-class: true TemplateResponseDocumentFormFieldCheckbox: description: 'This class extends `TemplateResponseDocumentFormFieldBase`' @@ -10799,7 +10814,7 @@ components: signature: '#/components/schemas/TemplateResponseDocumentStaticFieldSignature' date_signed: '#/components/schemas/TemplateResponseDocumentStaticFieldDateSigned' initials: '#/components/schemas/TemplateResponseDocumentStaticFieldInitials' - x-internal: true + x-internal-class: true x-base-class: true TemplateResponseDocumentStaticFieldCheckbox: description: 'This class extends `TemplateResponseDocumentStaticFieldBase`' @@ -11019,7 +11034,7 @@ components: description: 'Number of characters per line.' type: integer type: object - x-internal: true + x-internal-class: true TemplateResponseSignerRole: properties: name: @@ -11029,7 +11044,7 @@ components: description: 'If signer order is assigned this is the 0-based index for this role.' type: integer type: object - x-internal: true + x-internal-class: true TemplateUpdateFilesResponseTemplate: description: 'Contains template id' properties: @@ -11043,7 +11058,7 @@ components: $ref: '#/components/schemas/WarningResponse' deprecated: true type: object - x-internal: true + x-internal-class: true UnclaimedDraftResponse: description: 'A group of documents that a user can take ownership of via the claim URL.' properties: @@ -11070,7 +11085,7 @@ components: description: 'Whether this is a test draft. Signature requests made from test drafts have no legal value.' type: boolean type: object - x-internal: true + x-internal-class: true WarningResponse: description: 'A list of warnings.' required: @@ -11094,7 +11109,7 @@ components: items: $ref: '#/components/schemas/WarningResponse' type: object - x-internal: true + x-internal-class: true TeamGetInfoResponse: properties: team: @@ -11105,7 +11120,7 @@ components: items: $ref: '#/components/schemas/WarningResponse' type: object - x-internal: true + x-internal-class: true TeamInvitesResponse: properties: team_invites: @@ -11118,7 +11133,7 @@ components: items: $ref: '#/components/schemas/WarningResponse' type: object - x-internal: true + x-internal-class: true TeamMembersResponse: properties: team_members: @@ -11133,7 +11148,7 @@ components: items: $ref: '#/components/schemas/WarningResponse' type: object - x-internal: true + x-internal-class: true TeamSubTeamsResponse: properties: sub_teams: @@ -11148,7 +11163,7 @@ components: items: $ref: '#/components/schemas/WarningResponse' type: object - x-internal: true + x-internal-class: true TemplateCreateResponse: properties: template: @@ -11159,7 +11174,7 @@ components: items: $ref: '#/components/schemas/WarningResponse' type: object - x-internal: true + x-internal-class: true TemplateCreateEmbeddedDraftResponse: properties: template: @@ -11170,7 +11185,7 @@ components: items: $ref: '#/components/schemas/WarningResponse' type: object - x-internal: true + x-internal-class: true TemplateEditResponse: properties: template_id: @@ -11187,7 +11202,7 @@ components: items: $ref: '#/components/schemas/WarningResponse' type: object - x-internal: true + x-internal-class: true TemplateListResponse: properties: templates: @@ -11203,13 +11218,13 @@ components: items: $ref: '#/components/schemas/WarningResponse' type: object - x-internal: true + x-internal-class: true TemplateUpdateFilesResponse: properties: template: $ref: '#/components/schemas/TemplateUpdateFilesResponseTemplate' type: object - x-internal: true + x-internal-class: true UnclaimedDraftCreateResponse: properties: unclaimed_draft: @@ -11220,7 +11235,7 @@ components: items: $ref: '#/components/schemas/WarningResponse' type: object - x-internal: true + x-internal-class: true EventCallbackRequest: title: EventCallbackRequest required: diff --git a/setup.py b/setup.py index 039dc5b..63dcfd9 100644 --- a/setup.py +++ b/setup.py @@ -13,7 +13,7 @@ from pathlib import Path NAME = "dropbox-sign" -VERSION = "1.4.2" +VERSION = "1.5.0" # To install the library, run the following # # python setup.py install