diff --git a/sdks/python/README.md b/sdks/python/README.md index 8897d3033..1cd2512b5 100644 --- a/sdks/python/README.md +++ b/sdks/python/README.md @@ -1,5 +1,4 @@ # dropbox-sign - Dropbox Sign v3 API ## Migrating from legacy SDK @@ -103,8 +102,8 @@ with ApiClient(configuration) as api_client: All URIs are relative to *https://api.hellosign.com/v3* -|Class | Method | HTTP request | Description| -|------------ | ------------- | ------------- | -------------| +Class | Method | HTTP request | Description +------------ | ------------- | ------------- | ------------- |```AccountApi``` | [```account_create```](docs/AccountApi.md#account_create) | ```POST /account/create``` | Create Account| ```AccountApi``` | [```account_get```](docs/AccountApi.md#account_get) | ```GET /account``` | Get Account| ```AccountApi``` | [```account_update```](docs/AccountApi.md#account_update) | ```PUT /account``` | Update Account| diff --git a/sdks/python/docs/AccountApi.md b/sdks/python/docs/AccountApi.md index 4622cea01..0ba88eabc 100644 --- a/sdks/python/docs/AccountApi.md +++ b/sdks/python/docs/AccountApi.md @@ -2,8 +2,8 @@ All URIs are relative to *https://api.hellosign.com/v3* -|Method | HTTP request | Description| -|------------- | ------------- | -------------| +Method | HTTP request | Description +------------- | ------------- | ------------- |[```account_create```](AccountApi.md#account_create) | ```POST /account/create``` | Create Account| |[```account_get```](AccountApi.md#account_get) | ```GET /account``` | Get Account| |[```account_update```](AccountApi.md#account_update) | ```PUT /account``` | Update Account| @@ -53,7 +53,6 @@ with ApiClient(configuration) as api_client: ### Parameters - | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `account_create_request` | [**AccountCreateRequest**](AccountCreateRequest.md) | | | @@ -120,7 +119,6 @@ with ApiClient(configuration) as api_client: ### Parameters - | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `account_id` | **str** | `account_id` or `email_address` is required. If both are provided, the account id prevails. The ID of the Account. | [optional] | @@ -192,7 +190,6 @@ with ApiClient(configuration) as api_client: ### Parameters - | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `account_update_request` | [**AccountUpdateRequest**](AccountUpdateRequest.md) | | | @@ -263,7 +260,6 @@ with ApiClient(configuration) as api_client: ### Parameters - | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `account_verify_request` | [**AccountVerifyRequest**](AccountVerifyRequest.md) | | | diff --git a/sdks/python/docs/AccountCreateRequest.md b/sdks/python/docs/AccountCreateRequest.md index 6a2c3497a..6801084e8 100644 --- a/sdks/python/docs/AccountCreateRequest.md +++ b/sdks/python/docs/AccountCreateRequest.md @@ -3,15 +3,13 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `email_address`*_required_ | ```str``` | The email address which will be associated with the new Account. | | | `client_id` | ```str``` | Used when creating a new account with OAuth authorization.

See [OAuth 2.0 Authorization](https://app.hellosign.com/api/oauthWalkthrough#OAuthAuthorization) | | | `client_secret` | ```str``` | Used when creating a new account with OAuth authorization.

See [OAuth 2.0 Authorization](https://app.hellosign.com/api/oauthWalkthrough#OAuthAuthorization) | | | `locale` | ```str``` | 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. | | - [[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/sdks/python/docs/AccountCreateResponse.md b/sdks/python/docs/AccountCreateResponse.md index 7e6fcca4e..fa9be5221 100644 --- a/sdks/python/docs/AccountCreateResponse.md +++ b/sdks/python/docs/AccountCreateResponse.md @@ -3,14 +3,12 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `account` | [```AccountResponse```](AccountResponse.md) | | | | `oauth_data` | [```OAuthTokenResponse```](OAuthTokenResponse.md) | | | | `warnings` | [```[WarningResponse]```](WarningResponse.md) | A list of warnings. | | - [[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/sdks/python/docs/AccountGetResponse.md b/sdks/python/docs/AccountGetResponse.md index 336716629..1cc7ef497 100644 --- a/sdks/python/docs/AccountGetResponse.md +++ b/sdks/python/docs/AccountGetResponse.md @@ -3,13 +3,11 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `account` | [```AccountResponse```](AccountResponse.md) | | | | `warnings` | [```[WarningResponse]```](WarningResponse.md) | A list of warnings. | | - [[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/sdks/python/docs/AccountResponse.md b/sdks/python/docs/AccountResponse.md index cf5552679..f44286e88 100644 --- a/sdks/python/docs/AccountResponse.md +++ b/sdks/python/docs/AccountResponse.md @@ -3,9 +3,8 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `account_id` | ```str``` | The ID of the Account | | | `email_address` | ```str``` | The email address associated with the Account. | | | `is_locked` | ```bool``` | Returns `true` if the user has been locked out of their account by a team admin. | | @@ -18,7 +17,6 @@ | `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/sdks/python/docs/AccountResponseQuotas.md b/sdks/python/docs/AccountResponseQuotas.md index bdf6974d4..4d63611c6 100644 --- a/sdks/python/docs/AccountResponseQuotas.md +++ b/sdks/python/docs/AccountResponseQuotas.md @@ -3,9 +3,8 @@ Details concerning remaining monthly quotas. ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `api_signature_requests_left` | ```int, none_type``` | API signature requests remaining. | | | `documents_left` | ```int, none_type``` | Signature requests remaining. | | | `templates_total` | ```int, none_type``` | Total API templates allowed. | | @@ -13,7 +12,6 @@ Details concerning remaining monthly quotas. | `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/sdks/python/docs/AccountResponseUsage.md b/sdks/python/docs/AccountResponseUsage.md index e6e51d2bc..941021974 100644 --- a/sdks/python/docs/AccountResponseUsage.md +++ b/sdks/python/docs/AccountResponseUsage.md @@ -3,12 +3,10 @@ Details concerning monthly usage ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +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/sdks/python/docs/AccountUpdateRequest.md b/sdks/python/docs/AccountUpdateRequest.md index 0d76f5c75..bdf95c139 100644 --- a/sdks/python/docs/AccountUpdateRequest.md +++ b/sdks/python/docs/AccountUpdateRequest.md @@ -3,14 +3,12 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `account_id` | ```str, none_type``` | The ID of the Account | | | `callback_url` | ```str``` | The URL that Dropbox Sign should POST events to. | | | `locale` | ```str``` | 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. | | - [[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/sdks/python/docs/AccountVerifyRequest.md b/sdks/python/docs/AccountVerifyRequest.md index 946859eb5..477b47f9a 100644 --- a/sdks/python/docs/AccountVerifyRequest.md +++ b/sdks/python/docs/AccountVerifyRequest.md @@ -3,12 +3,10 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `email_address`*_required_ | ```str``` | Email address to run the verification for. | | - [[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/sdks/python/docs/AccountVerifyResponse.md b/sdks/python/docs/AccountVerifyResponse.md index cde5fdd7e..dc5261b7e 100644 --- a/sdks/python/docs/AccountVerifyResponse.md +++ b/sdks/python/docs/AccountVerifyResponse.md @@ -3,13 +3,11 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `account` | [```AccountVerifyResponseAccount```](AccountVerifyResponseAccount.md) | | | | `warnings` | [```[WarningResponse]```](WarningResponse.md) | A list of warnings. | | - [[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/sdks/python/docs/AccountVerifyResponseAccount.md b/sdks/python/docs/AccountVerifyResponseAccount.md index b9359ab78..b2f7d7142 100644 --- a/sdks/python/docs/AccountVerifyResponseAccount.md +++ b/sdks/python/docs/AccountVerifyResponseAccount.md @@ -3,12 +3,10 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `email_address` | ```str``` | The email address associated with the Account. | | - [[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/sdks/python/docs/ApiAppApi.md b/sdks/python/docs/ApiAppApi.md index 7453340b3..153830bcc 100644 --- a/sdks/python/docs/ApiAppApi.md +++ b/sdks/python/docs/ApiAppApi.md @@ -2,8 +2,8 @@ All URIs are relative to *https://api.hellosign.com/v3* -|Method | HTTP request | Description| -|------------- | ------------- | -------------| +Method | HTTP request | Description +------------- | ------------- | ------------- |[```api_app_create```](ApiAppApi.md#api_app_create) | ```POST /api_app``` | Create API App| |[```api_app_delete```](ApiAppApi.md#api_app_delete) | ```DELETE /api_app/{client_id}``` | Delete API App| |[```api_app_get```](ApiAppApi.md#api_app_get) | ```GET /api_app/{client_id}``` | Get API App| @@ -70,7 +70,6 @@ with ApiClient(configuration) as api_client: ### Parameters - | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `api_app_create_request` | [**ApiAppCreateRequest**](ApiAppCreateRequest.md) | | | @@ -136,7 +135,6 @@ with ApiClient(configuration) as api_client: ### Parameters - | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `client_id` | **str** | The client id of the API App to delete. | | @@ -205,7 +203,6 @@ with ApiClient(configuration) as api_client: ### Parameters - | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `client_id` | **str** | The client id of the API App to retrieve. | | @@ -278,7 +275,6 @@ with ApiClient(configuration) as api_client: ### Parameters - | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `page` | **int** | Which page number of the API App List to return. Defaults to `1`. | [optional][default to 1] | @@ -362,7 +358,6 @@ with ApiClient(configuration) as api_client: ### Parameters - | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `client_id` | **str** | The client id of the API App to update. | | diff --git a/sdks/python/docs/ApiAppCreateRequest.md b/sdks/python/docs/ApiAppCreateRequest.md index 4e9fe09f5..c416485ab 100644 --- a/sdks/python/docs/ApiAppCreateRequest.md +++ b/sdks/python/docs/ApiAppCreateRequest.md @@ -3,9 +3,8 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `domains`*_required_ | ```[str]``` | The domain names the ApiApp will be associated with. | | | `name`*_required_ | ```str``` | The name you want to assign to the ApiApp. | | | `callback_url` | ```str``` | The URL at which the ApiApp should receive event callbacks. | | @@ -14,7 +13,6 @@ | `options` | [```SubOptions```](SubOptions.md) | | | | `white_labeling_options` | [```SubWhiteLabelingOptions```](SubWhiteLabelingOptions.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/sdks/python/docs/ApiAppGetResponse.md b/sdks/python/docs/ApiAppGetResponse.md index fabf32fe0..2cb2aaff1 100644 --- a/sdks/python/docs/ApiAppGetResponse.md +++ b/sdks/python/docs/ApiAppGetResponse.md @@ -3,13 +3,11 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `api_app` | [```ApiAppResponse```](ApiAppResponse.md) | | | | `warnings` | [```[WarningResponse]```](WarningResponse.md) | A list of warnings. | | - [[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/sdks/python/docs/ApiAppListResponse.md b/sdks/python/docs/ApiAppListResponse.md index 964bcbc22..404f3d0a1 100644 --- a/sdks/python/docs/ApiAppListResponse.md +++ b/sdks/python/docs/ApiAppListResponse.md @@ -3,14 +3,12 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `api_apps` | [```[ApiAppResponse]```](ApiAppResponse.md) | Contains information about API Apps. | | | `list_info` | [```ListInfoResponse```](ListInfoResponse.md) | | | | `warnings` | [```[WarningResponse]```](WarningResponse.md) | A list of warnings. | | - [[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/sdks/python/docs/ApiAppResponse.md b/sdks/python/docs/ApiAppResponse.md index 5a7a14f99..997438c06 100644 --- a/sdks/python/docs/ApiAppResponse.md +++ b/sdks/python/docs/ApiAppResponse.md @@ -3,9 +3,8 @@ Contains information about an API App. ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `callback_url` | ```str, none_type``` | The app's callback URL (for events) | | | `client_id` | ```str``` | The app's client id | | | `created_at` | ```int``` | The time that the app was created | | @@ -17,7 +16,6 @@ Contains information about an API App. | `owner_account` | [```ApiAppResponseOwnerAccount```](ApiAppResponseOwnerAccount.md) | | | | `white_labeling_options` | [```ApiAppResponseWhiteLabelingOptions```](ApiAppResponseWhiteLabelingOptions.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/sdks/python/docs/ApiAppResponseOAuth.md b/sdks/python/docs/ApiAppResponseOAuth.md index 2f3f281be..4c3826de1 100644 --- a/sdks/python/docs/ApiAppResponseOAuth.md +++ b/sdks/python/docs/ApiAppResponseOAuth.md @@ -3,15 +3,13 @@ An object describing the app's OAuth properties, or null if OAuth is not configured for the app. ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `callback_url` | ```str``` | The app's OAuth callback URL. | | | `secret` | ```str``` | The app's OAuth secret, or null if the app does not belong to user. | | | `scopes` | ```[str]``` | Array of OAuth scopes used by the app. | | | `charges_users` | ```bool``` | Boolean indicating whether the app owner or the account granting permission is billed for OAuth requests. | | - [[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/sdks/python/docs/ApiAppResponseOptions.md b/sdks/python/docs/ApiAppResponseOptions.md index d97398f10..a96d6de0b 100644 --- a/sdks/python/docs/ApiAppResponseOptions.md +++ b/sdks/python/docs/ApiAppResponseOptions.md @@ -3,12 +3,10 @@ An object with options that override account settings. ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `can_insert_everywhere` | ```bool``` | Boolean denoting if signers can "Insert Everywhere" in one click while signing a document | | - [[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/sdks/python/docs/ApiAppResponseOwnerAccount.md b/sdks/python/docs/ApiAppResponseOwnerAccount.md index a15eaa278..b1cd337a1 100644 --- a/sdks/python/docs/ApiAppResponseOwnerAccount.md +++ b/sdks/python/docs/ApiAppResponseOwnerAccount.md @@ -3,13 +3,11 @@ An object describing the app's owner ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `account_id` | ```str``` | The owner account's ID | | | `email_address` | ```str``` | The owner account's email address | | - [[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/sdks/python/docs/ApiAppResponseWhiteLabelingOptions.md b/sdks/python/docs/ApiAppResponseWhiteLabelingOptions.md index eca248444..ae742c2e9 100644 --- a/sdks/python/docs/ApiAppResponseWhiteLabelingOptions.md +++ b/sdks/python/docs/ApiAppResponseWhiteLabelingOptions.md @@ -3,9 +3,8 @@ An object with options to customize the app's signer page ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `header_background_color` | ```str``` | | | | `legal_version` | ```str``` | | | | `link_color` | ```str``` | | | @@ -21,7 +20,6 @@ An object with options to customize the app's signer page | `text_color1` | ```str``` | | | | `text_color2` | ```str``` | | | - [[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/sdks/python/docs/ApiAppUpdateRequest.md b/sdks/python/docs/ApiAppUpdateRequest.md index e2cfaf79e..87cb951a2 100644 --- a/sdks/python/docs/ApiAppUpdateRequest.md +++ b/sdks/python/docs/ApiAppUpdateRequest.md @@ -3,9 +3,8 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `callback_url` | ```str``` | The URL at which the API App should receive event callbacks. | | | `custom_logo_file` | ```file_type``` | An image file to use as a custom logo in embedded contexts. (Only applies to some API plans) | | | `domains` | ```[str]``` | The domain names the ApiApp will be associated with. | | @@ -14,7 +13,6 @@ | `options` | [```SubOptions```](SubOptions.md) | | | | `white_labeling_options` | [```SubWhiteLabelingOptions```](SubWhiteLabelingOptions.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/sdks/python/docs/BulkSendJobApi.md b/sdks/python/docs/BulkSendJobApi.md index ef5f43791..8261fc114 100644 --- a/sdks/python/docs/BulkSendJobApi.md +++ b/sdks/python/docs/BulkSendJobApi.md @@ -2,8 +2,8 @@ All URIs are relative to *https://api.hellosign.com/v3* -|Method | HTTP request | Description| -|------------- | ------------- | -------------| +Method | HTTP request | Description +------------- | ------------- | ------------- |[```bulk_send_job_get```](BulkSendJobApi.md#bulk_send_job_get) | ```GET /bulk_send_job/{bulk_send_job_id}``` | Get Bulk Send Job| |[```bulk_send_job_list```](BulkSendJobApi.md#bulk_send_job_list) | ```GET /bulk_send_job/list``` | List Bulk Send Jobs| @@ -49,7 +49,6 @@ with ApiClient(configuration) as api_client: ### Parameters - | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `bulk_send_job_id` | **str** | The id of the BulkSendJob to retrieve. | | @@ -124,7 +123,6 @@ with ApiClient(configuration) as api_client: ### Parameters - | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `page` | **int** | Which page number of the BulkSendJob List to return. Defaults to `1`. | [optional][default to 1] | diff --git a/sdks/python/docs/BulkSendJobGetResponse.md b/sdks/python/docs/BulkSendJobGetResponse.md index 3718a3973..768a59569 100644 --- a/sdks/python/docs/BulkSendJobGetResponse.md +++ b/sdks/python/docs/BulkSendJobGetResponse.md @@ -3,15 +3,13 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `bulk_send_job` | [```BulkSendJobResponse```](BulkSendJobResponse.md) | | | | `list_info` | [```ListInfoResponse```](ListInfoResponse.md) | | | | `signature_requests` | [```[BulkSendJobGetResponseSignatureRequests]```](BulkSendJobGetResponseSignatureRequests.md) | Contains information about the Signature Requests sent in bulk. | | | `warnings` | [```[WarningResponse]```](WarningResponse.md) | A list of warnings. | | - [[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/sdks/python/docs/BulkSendJobGetResponseSignatureRequests.md b/sdks/python/docs/BulkSendJobGetResponseSignatureRequests.md index 660eb8134..ba65e5452 100644 --- a/sdks/python/docs/BulkSendJobGetResponseSignatureRequests.md +++ b/sdks/python/docs/BulkSendJobGetResponseSignatureRequests.md @@ -3,9 +3,8 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `test_mode` | ```bool, none_type``` | Whether this is a test signature request. Test requests have no legal value. Defaults to `false`. | [default to False] | | `signature_request_id` | ```str``` | The id of the SignatureRequest. | | | `requester_email_address` | ```str``` | The email address of the initiator of the SignatureRequest. | | @@ -32,7 +31,6 @@ | `signatures` | [```[SignatureRequestResponseSignatures]```](SignatureRequestResponseSignatures.md) | An array of signature objects, 1 for each signer. | | | `bulk_send_job_id` | ```str``` | The id of the BulkSendJob. | | - [[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/sdks/python/docs/BulkSendJobListResponse.md b/sdks/python/docs/BulkSendJobListResponse.md index ef64fd8aa..b86184543 100644 --- a/sdks/python/docs/BulkSendJobListResponse.md +++ b/sdks/python/docs/BulkSendJobListResponse.md @@ -3,14 +3,12 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `bulk_send_jobs` | [```[BulkSendJobResponse]```](BulkSendJobResponse.md) | Contains a list of BulkSendJobs that the API caller has access to. | | | `list_info` | [```ListInfoResponse```](ListInfoResponse.md) | | | | `warnings` | [```[WarningResponse]```](WarningResponse.md) | A list of warnings. | | - [[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/sdks/python/docs/BulkSendJobResponse.md b/sdks/python/docs/BulkSendJobResponse.md index eca78a4c0..2ec321e73 100644 --- a/sdks/python/docs/BulkSendJobResponse.md +++ b/sdks/python/docs/BulkSendJobResponse.md @@ -3,15 +3,13 @@ Contains information about the BulkSendJob such as when it was created and how many signature requests are queued. ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `bulk_send_job_id` | ```str, none_type``` | The id of the BulkSendJob. | | | `total` | ```int``` | The total amount of Signature Requests queued for sending. | | | `is_creator` | ```bool``` | True if you are the owner of this BulkSendJob, false if it's been shared with you by a team member. | | | `created_at` | ```int``` | Time that the BulkSendJob was created. | | - [[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/sdks/python/docs/BulkSendJobSendResponse.md b/sdks/python/docs/BulkSendJobSendResponse.md index 2dd2d47b7..fe59dabb1 100644 --- a/sdks/python/docs/BulkSendJobSendResponse.md +++ b/sdks/python/docs/BulkSendJobSendResponse.md @@ -3,13 +3,11 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `bulk_send_job` | [```BulkSendJobResponse```](BulkSendJobResponse.md) | | | | `warnings` | [```[WarningResponse]```](WarningResponse.md) | A list of warnings. | | - [[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/sdks/python/docs/EmbeddedApi.md b/sdks/python/docs/EmbeddedApi.md index 3c53b0254..cd283f8e9 100644 --- a/sdks/python/docs/EmbeddedApi.md +++ b/sdks/python/docs/EmbeddedApi.md @@ -2,8 +2,8 @@ All URIs are relative to *https://api.hellosign.com/v3* -|Method | HTTP request | Description| -|------------- | ------------- | -------------| +Method | HTTP request | Description +------------- | ------------- | ------------- |[```embedded_edit_url```](EmbeddedApi.md#embedded_edit_url) | ```POST /embedded/edit_url/{template_id}``` | Get Embedded Template Edit URL| |[```embedded_sign_url```](EmbeddedApi.md#embedded_sign_url) | ```GET /embedded/sign_url/{signature_id}``` | Get Embedded Sign URL| @@ -54,7 +54,6 @@ with ApiClient(configuration) as api_client: ### Parameters - | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `template_id` | **str** | The id of the template to edit. | | @@ -124,7 +123,6 @@ with ApiClient(configuration) as api_client: ### Parameters - | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `signature_id` | **str** | The id of the signature to get a signature url for. | | diff --git a/sdks/python/docs/EmbeddedEditUrlRequest.md b/sdks/python/docs/EmbeddedEditUrlRequest.md index 47d4284f3..454c90ea3 100644 --- a/sdks/python/docs/EmbeddedEditUrlRequest.md +++ b/sdks/python/docs/EmbeddedEditUrlRequest.md @@ -3,9 +3,8 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `allow_edit_ccs` | ```bool``` | This allows the requester to enable/disable to add or change CC roles when editing the template. | [default to False] | | `cc_roles` | ```[str]``` | The CC roles that must be assigned when using the template to send a signature request. To remove all CC roles, pass in a single role with no name. For use in a POST request. | | | `editor_options` | [```SubEditorOptions```](SubEditorOptions.md) | | | @@ -17,7 +16,6 @@ | `show_progress_stepper` | ```bool``` | When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. | [default to True] | | `test_mode` | ```bool``` | Whether this is a test, locked templates will only be available for editing if this is set to `true`. Defaults to `false`. | [default to False] | - [[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/sdks/python/docs/EmbeddedEditUrlResponse.md b/sdks/python/docs/EmbeddedEditUrlResponse.md index aef313bf1..6a71db633 100644 --- a/sdks/python/docs/EmbeddedEditUrlResponse.md +++ b/sdks/python/docs/EmbeddedEditUrlResponse.md @@ -3,13 +3,11 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `embedded` | [```EmbeddedEditUrlResponseEmbedded```](EmbeddedEditUrlResponseEmbedded.md) | | | | `warnings` | [```[WarningResponse]```](WarningResponse.md) | A list of warnings. | | - [[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/sdks/python/docs/EmbeddedEditUrlResponseEmbedded.md b/sdks/python/docs/EmbeddedEditUrlResponseEmbedded.md index e00f6751c..f5e819aa7 100644 --- a/sdks/python/docs/EmbeddedEditUrlResponseEmbedded.md +++ b/sdks/python/docs/EmbeddedEditUrlResponseEmbedded.md @@ -3,13 +3,11 @@ An embedded template object. ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `edit_url` | ```str``` | A template url that can be opened in an iFrame. | | | `expires_at` | ```int``` | The specific time that the the `edit_url` link expires, in epoch. | | - [[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/sdks/python/docs/EmbeddedSignUrlResponse.md b/sdks/python/docs/EmbeddedSignUrlResponse.md index 307dc7dbe..c6952cc14 100644 --- a/sdks/python/docs/EmbeddedSignUrlResponse.md +++ b/sdks/python/docs/EmbeddedSignUrlResponse.md @@ -3,13 +3,11 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `embedded` | [```EmbeddedSignUrlResponseEmbedded```](EmbeddedSignUrlResponseEmbedded.md) | | | | `warnings` | [```[WarningResponse]```](WarningResponse.md) | A list of warnings. | | - [[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/sdks/python/docs/EmbeddedSignUrlResponseEmbedded.md b/sdks/python/docs/EmbeddedSignUrlResponseEmbedded.md index 098e46cf8..bf6fdbdae 100644 --- a/sdks/python/docs/EmbeddedSignUrlResponseEmbedded.md +++ b/sdks/python/docs/EmbeddedSignUrlResponseEmbedded.md @@ -3,13 +3,11 @@ An object that contains necessary information to set up embedded signing. ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `sign_url` | ```str``` | A signature url that can be opened in an iFrame. | | | `expires_at` | ```int``` | The specific time that the the `sign_url` link expires, in epoch. | | - [[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/sdks/python/docs/ErrorResponse.md b/sdks/python/docs/ErrorResponse.md index 9235a71c0..2f15b49a0 100644 --- a/sdks/python/docs/ErrorResponse.md +++ b/sdks/python/docs/ErrorResponse.md @@ -3,12 +3,10 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `error`*_required_ | [```ErrorResponseError```](ErrorResponseError.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/sdks/python/docs/ErrorResponseError.md b/sdks/python/docs/ErrorResponseError.md index d686a1f8f..f6052d69f 100644 --- a/sdks/python/docs/ErrorResponseError.md +++ b/sdks/python/docs/ErrorResponseError.md @@ -3,14 +3,12 @@ Contains information about an error that occurred. ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `error_msg`*_required_ | ```str``` | Message describing an error. | | | `error_name`*_required_ | ```str``` | Name of the error. | | | `error_path` | ```str``` | Path at which an error occurred. | | - [[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/sdks/python/docs/EventCallbackRequest.md b/sdks/python/docs/EventCallbackRequest.md index 6e3f73ade..dd9655bf1 100644 --- a/sdks/python/docs/EventCallbackRequest.md +++ b/sdks/python/docs/EventCallbackRequest.md @@ -3,15 +3,13 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `event`*_required_ | [```EventCallbackRequestEvent```](EventCallbackRequestEvent.md) | | | | `account` | [```AccountResponse```](AccountResponse.md) | | | | `signature_request` | [```SignatureRequestResponse```](SignatureRequestResponse.md) | | | | `template` | [```TemplateResponse```](TemplateResponse.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/sdks/python/docs/EventCallbackRequestEvent.md b/sdks/python/docs/EventCallbackRequestEvent.md index d658d01a1..2675bbf3c 100644 --- a/sdks/python/docs/EventCallbackRequestEvent.md +++ b/sdks/python/docs/EventCallbackRequestEvent.md @@ -3,15 +3,13 @@ Basic information about the event that occurred. ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `event_time`*_required_ | ```str``` | Time the event was created (using Unix time). | | | `event_type`*_required_ | ```str``` | Type of callback event that was triggered. | | | `event_hash`*_required_ | ```str``` | Generated hash used to verify source of event data. | | | `event_metadata` | [```EventCallbackRequestEventMetadata```](EventCallbackRequestEventMetadata.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/sdks/python/docs/EventCallbackRequestEventMetadata.md b/sdks/python/docs/EventCallbackRequestEventMetadata.md index 9de3e33aa..dc1fecc80 100644 --- a/sdks/python/docs/EventCallbackRequestEventMetadata.md +++ b/sdks/python/docs/EventCallbackRequestEventMetadata.md @@ -3,15 +3,13 @@ Specific metadata about the event. ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `related_signature_id` | ```str, none_type``` | Signature ID for a specific signer. Applicable to `signature_request_signed` and `signature_request_viewed` events. | | | `reported_for_account_id` | ```str, none_type``` | Account ID the event was reported for. | | | `reported_for_app_id` | ```str, none_type``` | App ID the event was reported for. | | | `event_message` | ```str, none_type``` | Message about a declined or failed (due to error) signature flow. | | - [[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/sdks/python/docs/FaxLineAddUserRequest.md b/sdks/python/docs/FaxLineAddUserRequest.md index 9ad0485b7..53cee4e69 100644 --- a/sdks/python/docs/FaxLineAddUserRequest.md +++ b/sdks/python/docs/FaxLineAddUserRequest.md @@ -3,14 +3,12 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `number`*_required_ | ```str``` | The Fax Line number. | | | `account_id` | ```str``` | Account ID | | | `email_address` | ```str``` | Email address | | - [[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/sdks/python/docs/FaxLineApi.md b/sdks/python/docs/FaxLineApi.md index 028d5fe83..5c6f20a4e 100644 --- a/sdks/python/docs/FaxLineApi.md +++ b/sdks/python/docs/FaxLineApi.md @@ -2,8 +2,8 @@ All URIs are relative to *https://api.hellosign.com/v3* -|Method | HTTP request | Description| -|------------- | ------------- | -------------| +Method | HTTP request | Description +------------- | ------------- | ------------- |[```fax_line_add_user```](FaxLineApi.md#fax_line_add_user) | ```PUT /fax_line/add_user``` | Add Fax Line User| |[```fax_line_area_code_get```](FaxLineApi.md#fax_line_area_code_get) | ```GET /fax_line/area_codes``` | Get Available Fax Line Area Codes| |[```fax_line_create```](FaxLineApi.md#fax_line_create) | ```POST /fax_line/create``` | Purchase Fax Line| @@ -53,7 +53,6 @@ with ApiClient(configuration) as api_client: ### Parameters - | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `fax_line_add_user_request` | [**FaxLineAddUserRequest**](FaxLineAddUserRequest.md) | | | @@ -116,7 +115,6 @@ with ApiClient(configuration) as api_client: ### Parameters - | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `country` | **str** | Filter area codes by country. | | @@ -187,7 +185,6 @@ with ApiClient(configuration) as api_client: ### Parameters - | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `fax_line_create_request` | [**FaxLineCreateRequest**](FaxLineCreateRequest.md) | | | @@ -253,7 +250,6 @@ with ApiClient(configuration) as api_client: ### Parameters - | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `fax_line_delete_request` | [**FaxLineDeleteRequest**](FaxLineDeleteRequest.md) | | | @@ -316,7 +312,6 @@ with ApiClient(configuration) as api_client: ### Parameters - | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `number` | **str** | The Fax Line number. | | @@ -379,7 +374,6 @@ with ApiClient(configuration) as api_client: ### Parameters - | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `account_id` | **str** | Account ID | [optional] | @@ -450,7 +444,6 @@ with ApiClient(configuration) as api_client: ### Parameters - | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `fax_line_remove_user_request` | [**FaxLineRemoveUserRequest**](FaxLineRemoveUserRequest.md) | | | diff --git a/sdks/python/docs/FaxLineAreaCodeGetCountryEnum.md b/sdks/python/docs/FaxLineAreaCodeGetCountryEnum.md index 2df64fe3d..3bb66b2db 100644 --- a/sdks/python/docs/FaxLineAreaCodeGetCountryEnum.md +++ b/sdks/python/docs/FaxLineAreaCodeGetCountryEnum.md @@ -3,10 +3,8 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | - +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- [[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/sdks/python/docs/FaxLineAreaCodeGetProvinceEnum.md b/sdks/python/docs/FaxLineAreaCodeGetProvinceEnum.md index 46be71327..a5d0565be 100644 --- a/sdks/python/docs/FaxLineAreaCodeGetProvinceEnum.md +++ b/sdks/python/docs/FaxLineAreaCodeGetProvinceEnum.md @@ -3,10 +3,8 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | - +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- [[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/sdks/python/docs/FaxLineAreaCodeGetResponse.md b/sdks/python/docs/FaxLineAreaCodeGetResponse.md index f05c3ec36..e46fcc0ba 100644 --- a/sdks/python/docs/FaxLineAreaCodeGetResponse.md +++ b/sdks/python/docs/FaxLineAreaCodeGetResponse.md @@ -3,12 +3,10 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `area_codes` | ```[int]``` | | | - [[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/sdks/python/docs/FaxLineAreaCodeGetStateEnum.md b/sdks/python/docs/FaxLineAreaCodeGetStateEnum.md index 9557a82b5..36b555f0d 100644 --- a/sdks/python/docs/FaxLineAreaCodeGetStateEnum.md +++ b/sdks/python/docs/FaxLineAreaCodeGetStateEnum.md @@ -3,10 +3,8 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | - +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- [[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/sdks/python/docs/FaxLineCreateRequest.md b/sdks/python/docs/FaxLineCreateRequest.md index 75eda463d..50f318c5b 100644 --- a/sdks/python/docs/FaxLineCreateRequest.md +++ b/sdks/python/docs/FaxLineCreateRequest.md @@ -3,15 +3,13 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `area_code`*_required_ | ```int``` | Area code | | | `country`*_required_ | ```str``` | Country | | | `city` | ```str``` | City | | | `account_id` | ```str``` | Account ID | | - [[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/sdks/python/docs/FaxLineDeleteRequest.md b/sdks/python/docs/FaxLineDeleteRequest.md index 8e803d32c..3dbaec9ec 100644 --- a/sdks/python/docs/FaxLineDeleteRequest.md +++ b/sdks/python/docs/FaxLineDeleteRequest.md @@ -3,12 +3,10 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `number`*_required_ | ```str``` | The Fax Line number. | | - [[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/sdks/python/docs/FaxLineListResponse.md b/sdks/python/docs/FaxLineListResponse.md index a4fecd5e1..b3ad6fe32 100644 --- a/sdks/python/docs/FaxLineListResponse.md +++ b/sdks/python/docs/FaxLineListResponse.md @@ -3,14 +3,12 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `list_info` | [```ListInfoResponse```](ListInfoResponse.md) | | | | `fax_lines` | [```[FaxLineResponseFaxLine]```](FaxLineResponseFaxLine.md) | | | | `warnings` | [```WarningResponse```](WarningResponse.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/sdks/python/docs/FaxLineRemoveUserRequest.md b/sdks/python/docs/FaxLineRemoveUserRequest.md index 934ff186a..353510868 100644 --- a/sdks/python/docs/FaxLineRemoveUserRequest.md +++ b/sdks/python/docs/FaxLineRemoveUserRequest.md @@ -3,14 +3,12 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `number`*_required_ | ```str``` | The Fax Line number. | | | `account_id` | ```str``` | Account ID | | | `email_address` | ```str``` | Email address | | - [[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/sdks/python/docs/FaxLineResponse.md b/sdks/python/docs/FaxLineResponse.md index 71128088c..fdc65102e 100644 --- a/sdks/python/docs/FaxLineResponse.md +++ b/sdks/python/docs/FaxLineResponse.md @@ -3,13 +3,11 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `fax_line` | [```FaxLineResponseFaxLine```](FaxLineResponseFaxLine.md) | | | | `warnings` | [```WarningResponse```](WarningResponse.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/sdks/python/docs/FaxLineResponseFaxLine.md b/sdks/python/docs/FaxLineResponseFaxLine.md index 1eea506f9..6c06de280 100644 --- a/sdks/python/docs/FaxLineResponseFaxLine.md +++ b/sdks/python/docs/FaxLineResponseFaxLine.md @@ -3,15 +3,13 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `number` | ```str``` | Number | | | `created_at` | ```int``` | Created at | | | `updated_at` | ```int``` | Updated at | | | `accounts` | [```[AccountResponse]```](AccountResponse.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/sdks/python/docs/FileResponse.md b/sdks/python/docs/FileResponse.md index 8c6b21151..c15596412 100644 --- a/sdks/python/docs/FileResponse.md +++ b/sdks/python/docs/FileResponse.md @@ -3,13 +3,11 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `file_url` | ```str``` | URL to the file. | | | `expires_at` | ```int``` | When the link expires. | | - [[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/sdks/python/docs/FileResponseDataUri.md b/sdks/python/docs/FileResponseDataUri.md index 4488bf6df..4ba4524cf 100644 --- a/sdks/python/docs/FileResponseDataUri.md +++ b/sdks/python/docs/FileResponseDataUri.md @@ -3,12 +3,10 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `data_uri` | ```str``` | File as base64 encoded string. | | - [[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/sdks/python/docs/ListInfoResponse.md b/sdks/python/docs/ListInfoResponse.md index ee5d51085..6be140f3b 100644 --- a/sdks/python/docs/ListInfoResponse.md +++ b/sdks/python/docs/ListInfoResponse.md @@ -3,15 +3,13 @@ Contains pagination information about the data returned. ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `num_pages` | ```int``` | Total number of pages available. | | | `num_results` | ```int, none_type``` | Total number of objects available. | | | `page` | ```int``` | Number of the page being returned. | | | `page_size` | ```int``` | Objects returned per page. | | - [[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/sdks/python/docs/OAuthApi.md b/sdks/python/docs/OAuthApi.md index 3c3d19171..f02abe866 100644 --- a/sdks/python/docs/OAuthApi.md +++ b/sdks/python/docs/OAuthApi.md @@ -2,8 +2,8 @@ All URIs are relative to *https://api.hellosign.com/v3* -|Method | HTTP request | Description| -|------------- | ------------- | -------------| +Method | HTTP request | Description +------------- | ------------- | ------------- |[```oauth_token_generate```](OAuthApi.md#oauth_token_generate) | ```POST /oauth/token``` | OAuth Token Generate| |[```oauth_token_refresh```](OAuthApi.md#oauth_token_refresh) | ```POST /oauth/token?refresh``` | OAuth Token Refresh| @@ -46,7 +46,6 @@ with ApiClient(configuration) as api_client: ### Parameters - | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `o_auth_token_generate_request` | [**OAuthTokenGenerateRequest**](OAuthTokenGenerateRequest.md) | | | @@ -108,7 +107,6 @@ with ApiClient(configuration) as api_client: ### Parameters - | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `o_auth_token_refresh_request` | [**OAuthTokenRefreshRequest**](OAuthTokenRefreshRequest.md) | | | diff --git a/sdks/python/docs/OAuthTokenGenerateRequest.md b/sdks/python/docs/OAuthTokenGenerateRequest.md index 89d7db3c3..bd6c69e7e 100644 --- a/sdks/python/docs/OAuthTokenGenerateRequest.md +++ b/sdks/python/docs/OAuthTokenGenerateRequest.md @@ -3,16 +3,14 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `client_id`*_required_ | ```str``` | The client id of the app requesting authorization. | | | `client_secret`*_required_ | ```str``` | The secret token of your app. | | | `code`*_required_ | ```str``` | The code passed to your callback when the user granted access. | | | `grant_type`*_required_ | ```str``` | When generating a new token use `authorization_code`. | [default to "authorization_code"] | | `state`*_required_ | ```str``` | Same as the state you specified earlier. | | - [[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/sdks/python/docs/OAuthTokenRefreshRequest.md b/sdks/python/docs/OAuthTokenRefreshRequest.md index 99bef2e0f..792117aab 100644 --- a/sdks/python/docs/OAuthTokenRefreshRequest.md +++ b/sdks/python/docs/OAuthTokenRefreshRequest.md @@ -3,13 +3,11 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `grant_type`*_required_ | ```str``` | When refreshing an existing token use `refresh_token`. | [default to "refresh_token"] | | `refresh_token`*_required_ | ```str``` | The token provided when you got the expired access token. | | - [[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/sdks/python/docs/OAuthTokenResponse.md b/sdks/python/docs/OAuthTokenResponse.md index 4fc8542d7..d4713fbec 100644 --- a/sdks/python/docs/OAuthTokenResponse.md +++ b/sdks/python/docs/OAuthTokenResponse.md @@ -3,16 +3,14 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `access_token` | ```str``` | | | | `token_type` | ```str``` | | | | `refresh_token` | ```str``` | | | | `expires_in` | ```int``` | Number of seconds until the `access_token` expires. Uses epoch time. | | | `state` | ```str, none_type``` | | | - [[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/sdks/python/docs/ReportApi.md b/sdks/python/docs/ReportApi.md index 1391cd418..fb246462f 100644 --- a/sdks/python/docs/ReportApi.md +++ b/sdks/python/docs/ReportApi.md @@ -2,8 +2,8 @@ All URIs are relative to *https://api.hellosign.com/v3* -|Method | HTTP request | Description| -|------------- | ------------- | -------------| +Method | HTTP request | Description +------------- | ------------- | ------------- |[```report_create```](ReportApi.md#report_create) | ```POST /report/create``` | Create Report| @@ -51,7 +51,6 @@ with ApiClient(configuration) as api_client: ### Parameters - | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `report_create_request` | [**ReportCreateRequest**](ReportCreateRequest.md) | | | diff --git a/sdks/python/docs/ReportCreateRequest.md b/sdks/python/docs/ReportCreateRequest.md index aaa25a321..56105d062 100644 --- a/sdks/python/docs/ReportCreateRequest.md +++ b/sdks/python/docs/ReportCreateRequest.md @@ -3,14 +3,12 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `end_date`*_required_ | ```str``` | The (inclusive) end date for the report data in `MM/DD/YYYY` format. | | | `report_type`*_required_ | ```[str]``` | The type(s) of the report you are requesting. Allowed values are `user_activity` and `document_status`. User activity reports contain list of all users and their activity during the specified date range. Document status report contain a list of signature requests created in the specified time range (and their status). | | | `start_date`*_required_ | ```str``` | The (inclusive) start date for the report data in `MM/DD/YYYY` format. | | - [[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/sdks/python/docs/ReportCreateResponse.md b/sdks/python/docs/ReportCreateResponse.md index 5272d9a1f..fbc387eed 100644 --- a/sdks/python/docs/ReportCreateResponse.md +++ b/sdks/python/docs/ReportCreateResponse.md @@ -3,13 +3,11 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `report` | [```ReportResponse```](ReportResponse.md) | | | | `warnings` | [```[WarningResponse]```](WarningResponse.md) | A list of warnings. | | - [[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/sdks/python/docs/ReportResponse.md b/sdks/python/docs/ReportResponse.md index 9c5b1a63e..baeb76509 100644 --- a/sdks/python/docs/ReportResponse.md +++ b/sdks/python/docs/ReportResponse.md @@ -3,15 +3,13 @@ Contains information about the report request. ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `success` | ```str``` | A message indicating the requested operation's success | | | `start_date` | ```str``` | The (inclusive) start date for the report data in MM/DD/YYYY format. | | | `end_date` | ```str``` | The (inclusive) end date for the report data in MM/DD/YYYY format. | | | `report_type` | ```[str]``` | The type(s) of the report you are requesting. Allowed values are "user_activity" and "document_status". User activity reports contain list of all users and their activity during the specified date range. Document status report contain a list of signature requests created in the specified time range (and their status). | | - [[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/sdks/python/docs/SignatureRequestApi.md b/sdks/python/docs/SignatureRequestApi.md index ada94d4a6..fb10d73d6 100644 --- a/sdks/python/docs/SignatureRequestApi.md +++ b/sdks/python/docs/SignatureRequestApi.md @@ -2,8 +2,8 @@ All URIs are relative to *https://api.hellosign.com/v3* -|Method | HTTP request | Description| -|------------- | ------------- | -------------| +Method | HTTP request | Description +------------- | ------------- | ------------- |[```signature_request_bulk_create_embedded_with_template```](SignatureRequestApi.md#signature_request_bulk_create_embedded_with_template) | ```POST /signature_request/bulk_create_embedded_with_template``` | Embedded Bulk Send with Template| |[```signature_request_bulk_send_with_template```](SignatureRequestApi.md#signature_request_bulk_send_with_template) | ```POST /signature_request/bulk_send_with_template``` | Bulk Send with Template| |[```signature_request_cancel```](SignatureRequestApi.md#signature_request_cancel) | ```POST /signature_request/cancel/{signature_request_id}``` | Cancel Incomplete Signature Request| @@ -109,7 +109,6 @@ with ApiClient(configuration) as api_client: ### Parameters - | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `signature_request_bulk_create_embedded_with_template_request` | [**SignatureRequestBulkCreateEmbeddedWithTemplateRequest**](SignatureRequestBulkCreateEmbeddedWithTemplateRequest.md) | | | @@ -224,7 +223,6 @@ with ApiClient(configuration) as api_client: ### Parameters - | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `signature_request_bulk_send_with_template_request` | [**SignatureRequestBulkSendWithTemplateRequest**](SignatureRequestBulkSendWithTemplateRequest.md) | | | @@ -290,7 +288,6 @@ with ApiClient(configuration) as api_client: ### Parameters - | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `signature_request_id` | **str** | The id of the incomplete SignatureRequest to cancel. | | @@ -389,7 +386,6 @@ with ApiClient(configuration) as api_client: ### Parameters - | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `signature_request_create_embedded_request` | [**SignatureRequestCreateEmbeddedRequest**](SignatureRequestCreateEmbeddedRequest.md) | | | @@ -480,7 +476,6 @@ with ApiClient(configuration) as api_client: ### Parameters - | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `signature_request_create_embedded_with_template_request` | [**SignatureRequestCreateEmbeddedWithTemplateRequest**](SignatureRequestCreateEmbeddedWithTemplateRequest.md) | | | @@ -549,7 +544,6 @@ with ApiClient(configuration) as api_client: ### Parameters - | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `signature_request_id` | **str** | The id of the SignatureRequest to retrieve. | | @@ -619,7 +613,6 @@ with ApiClient(configuration) as api_client: ### Parameters - | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `signature_request_id` | **str** | The id of the SignatureRequest to retrieve. | | @@ -688,7 +681,6 @@ with ApiClient(configuration) as api_client: ### Parameters - | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `signature_request_id` | **str** | The id of the SignatureRequest to retrieve. | | @@ -758,7 +750,6 @@ with ApiClient(configuration) as api_client: ### Parameters - | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `signature_request_id` | **str** | The id of the SignatureRequest to retrieve. | | @@ -831,7 +822,6 @@ with ApiClient(configuration) as api_client: ### Parameters - | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `account_id` | **str** | Which account to return SignatureRequests for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. | [optional] | @@ -903,7 +893,6 @@ with ApiClient(configuration) as api_client: ### Parameters - | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `signature_request_id` | **str** | The id of the SignatureRequest to release. | | @@ -976,7 +965,6 @@ with ApiClient(configuration) as api_client: ### Parameters - | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `signature_request_id` | **str** | The id of the SignatureRequest to send a reminder for. | | @@ -1042,7 +1030,6 @@ with ApiClient(configuration) as api_client: ### Parameters - | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `signature_request_id` | **str** | The id of the SignatureRequest to remove. | | @@ -1152,7 +1139,6 @@ with ApiClient(configuration) as api_client: ### Parameters - | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `signature_request_send_request` | [**SignatureRequestSendRequest**](SignatureRequestSendRequest.md) | | | @@ -1256,7 +1242,6 @@ with ApiClient(configuration) as api_client: ### Parameters - | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `signature_request_send_with_template_request` | [**SignatureRequestSendWithTemplateRequest**](SignatureRequestSendWithTemplateRequest.md) | | | @@ -1330,7 +1315,6 @@ with ApiClient(configuration) as api_client: ### Parameters - | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `signature_request_id` | **str** | The id of the SignatureRequest to update. | | diff --git a/sdks/python/docs/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.md b/sdks/python/docs/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.md index 2638f947d..0eda7b475 100644 --- a/sdks/python/docs/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.md +++ b/sdks/python/docs/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.md @@ -3,9 +3,8 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `template_ids`*_required_ | ```[str]``` | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. | | | `client_id`*_required_ | ```str``` | Client id of the app you're using to create this embedded signature request. Used for security purposes. | | | `signer_file` | ```file_type``` | `signer_file` is a CSV file defining values and options for signer fields. Required unless a `signer_list` is used, you may not use both. The CSV can have the following columns:

- `name`: the name of the signer filling the role of RoleName - `email_address`: email address of the signer filling the role of RoleName - `pin`: the 4- to 12-character access code that will secure this signer's signature page (optional) - `sms_phone_number`: An E.164 formatted phone number that will receive a code via SMS to access this signer's signature page. (optional)

By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on).

**NOTE:** Not available in test mode and requires a Standard plan or higher. - `*_field`: any column with a _field" suffix will be treated as a custom field (optional)

You may only specify field values here, any other options should be set in the custom_fields request parameter.

Example CSV:

``` name, email_address, pin, company_field George, george@example.com, d79a3td, ABC Corp Mary, mary@example.com, gd9as5b, 123 LLC ``` | | @@ -20,7 +19,6 @@ | `test_mode` | ```bool``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to False] | | `title` | ```str``` | The title you want to assign to the SignatureRequest. | | - [[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/sdks/python/docs/SignatureRequestBulkSendWithTemplateRequest.md b/sdks/python/docs/SignatureRequestBulkSendWithTemplateRequest.md index c13e5f445..64a38a765 100644 --- a/sdks/python/docs/SignatureRequestBulkSendWithTemplateRequest.md +++ b/sdks/python/docs/SignatureRequestBulkSendWithTemplateRequest.md @@ -3,9 +3,8 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `template_ids`*_required_ | ```[str]``` | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. | | | `signer_file` | ```file_type``` | `signer_file` is a CSV file defining values and options for signer fields. Required unless a `signer_list` is used, you may not use both. The CSV can have the following columns:

- `name`: the name of the signer filling the role of RoleName - `email_address`: email address of the signer filling the role of RoleName - `pin`: the 4- to 12-character access code that will secure this signer's signature page (optional) - `sms_phone_number`: An E.164 formatted phone number that will receive a code via SMS to access this signer's signature page. (optional)

By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on).

**NOTE:** Not available in test mode and requires a Standard plan or higher. - `*_field`: any column with a _field" suffix will be treated as a custom field (optional)

You may only specify field values here, any other options should be set in the custom_fields request parameter.

Example CSV:

``` name, email_address, pin, company_field George, george@example.com, d79a3td, ABC Corp Mary, mary@example.com, gd9as5b, 123 LLC ``` | | | `signer_list` | [```[SubBulkSignerList]```](SubBulkSignerList.md) | `signer_list` is an array defining values and options for signer fields. Required unless a `signer_file` is used, you may not use both. | | @@ -20,7 +19,6 @@ | `test_mode` | ```bool``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to False] | | `title` | ```str``` | The title you want to assign to the SignatureRequest. | | - [[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/sdks/python/docs/SignatureRequestCreateEmbeddedRequest.md b/sdks/python/docs/SignatureRequestCreateEmbeddedRequest.md index 0b8be5d25..a1ba83ff7 100644 --- a/sdks/python/docs/SignatureRequestCreateEmbeddedRequest.md +++ b/sdks/python/docs/SignatureRequestCreateEmbeddedRequest.md @@ -3,9 +3,8 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `client_id`*_required_ | ```str``` | Client id of the app you're using to create this embedded signature request. Used for security purposes. | | | `files` | ```[file_type]``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `file_urls` | ```[str]``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | @@ -31,7 +30,6 @@ | `populate_auto_fill_fields` | ```bool``` | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.

**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [default to False] | | `expires_at` | ```int, none_type``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | | - [[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/sdks/python/docs/SignatureRequestCreateEmbeddedWithTemplateRequest.md b/sdks/python/docs/SignatureRequestCreateEmbeddedWithTemplateRequest.md index e03242e68..51435be6c 100644 --- a/sdks/python/docs/SignatureRequestCreateEmbeddedWithTemplateRequest.md +++ b/sdks/python/docs/SignatureRequestCreateEmbeddedWithTemplateRequest.md @@ -3,9 +3,8 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `template_ids`*_required_ | ```[str]``` | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. | | | `client_id`*_required_ | ```str``` | Client id of the app you're using to create this embedded signature request. Used for security purposes. | | | `signers`*_required_ | [```[SubSignatureRequestTemplateSigner]```](SubSignatureRequestTemplateSigner.md) | Add Signers to your Templated-based Signature Request. | | @@ -22,7 +21,6 @@ | `title` | ```str``` | The title you want to assign to the SignatureRequest. | | | `populate_auto_fill_fields` | ```bool``` | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.

**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [default to False] | - [[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/sdks/python/docs/SignatureRequestGetResponse.md b/sdks/python/docs/SignatureRequestGetResponse.md index 09c74de50..f6ca41882 100644 --- a/sdks/python/docs/SignatureRequestGetResponse.md +++ b/sdks/python/docs/SignatureRequestGetResponse.md @@ -3,13 +3,11 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `signature_request` | [```SignatureRequestResponse```](SignatureRequestResponse.md) | | | | `warnings` | [```[WarningResponse]```](WarningResponse.md) | A list of warnings. | | - [[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/sdks/python/docs/SignatureRequestListResponse.md b/sdks/python/docs/SignatureRequestListResponse.md index 0e764640a..6f7f4692f 100644 --- a/sdks/python/docs/SignatureRequestListResponse.md +++ b/sdks/python/docs/SignatureRequestListResponse.md @@ -3,14 +3,12 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `signature_requests` | [```[SignatureRequestResponse]```](SignatureRequestResponse.md) | Contains information about signature requests. | | | `list_info` | [```ListInfoResponse```](ListInfoResponse.md) | | | | `warnings` | [```[WarningResponse]```](WarningResponse.md) | A list of warnings. | | - [[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/sdks/python/docs/SignatureRequestRemindRequest.md b/sdks/python/docs/SignatureRequestRemindRequest.md index 91a33805d..eebce01ce 100644 --- a/sdks/python/docs/SignatureRequestRemindRequest.md +++ b/sdks/python/docs/SignatureRequestRemindRequest.md @@ -3,13 +3,11 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `email_address`*_required_ | ```str``` | The email address of the signer to send a reminder to. | | | `name` | ```str``` | The name of the signer to send a reminder to. Include if two or more signers share an email address. | | - [[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/sdks/python/docs/SignatureRequestResponse.md b/sdks/python/docs/SignatureRequestResponse.md index eca1dc2ad..5a6594532 100644 --- a/sdks/python/docs/SignatureRequestResponse.md +++ b/sdks/python/docs/SignatureRequestResponse.md @@ -3,9 +3,8 @@ Contains information about a signature request. ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `test_mode` | ```bool, none_type``` | Whether this is a test signature request. Test requests have no legal value. Defaults to `false`. | [default to False] | | `signature_request_id` | ```str``` | The id of the SignatureRequest. | | | `requester_email_address` | ```str``` | The email address of the initiator of the SignatureRequest. | | @@ -32,7 +31,6 @@ Contains information about a signature request. | `signatures` | [```[SignatureRequestResponseSignatures]```](SignatureRequestResponseSignatures.md) | An array of signature objects, 1 for each signer. | | | `bulk_send_job_id` | ```str, none_type``` | The ID of the Bulk Send job which sent the signature request, if applicable. | | - [[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/sdks/python/docs/SignatureRequestResponseAttachment.md b/sdks/python/docs/SignatureRequestResponseAttachment.md index 322ac83a5..974b17a02 100644 --- a/sdks/python/docs/SignatureRequestResponseAttachment.md +++ b/sdks/python/docs/SignatureRequestResponseAttachment.md @@ -3,9 +3,8 @@ Signer attachments. ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `id`*_required_ | ```str``` | The unique ID for this attachment. | | | `signer`*_required_ | ```str``` | The Signer this attachment is assigned to. | | | `name`*_required_ | ```str``` | The name of this attachment. | | @@ -13,7 +12,6 @@ Signer attachments. | `instructions` | ```str, none_type``` | Instructions for Signer. | | | `uploaded_at` | ```int, none_type``` | Timestamp when attachment was uploaded by Signer. | | - [[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/sdks/python/docs/SignatureRequestResponseCustomFieldBase.md b/sdks/python/docs/SignatureRequestResponseCustomFieldBase.md index a218c0f5c..915e6f6ed 100644 --- a/sdks/python/docs/SignatureRequestResponseCustomFieldBase.md +++ b/sdks/python/docs/SignatureRequestResponseCustomFieldBase.md @@ -6,16 +6,14 @@ An array of Custom Field objects containing the name and type of each custom fie * Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox` ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```str``` | The type of this Custom Field. Only 'text' and 'checkbox' are currently supported. | | | `name`*_required_ | ```str``` | The name of the Custom Field. | | | `required` | ```bool``` | A boolean value denoting if this field is required. | | | `api_id` | ```str``` | The unique ID for this field. | | | `editor` | ```str``` | The name of the Role that is able to edit this field. | | - [[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/sdks/python/docs/SignatureRequestResponseCustomFieldCheckbox.md b/sdks/python/docs/SignatureRequestResponseCustomFieldCheckbox.md index 53bae66fc..6eb81404d 100644 --- a/sdks/python/docs/SignatureRequestResponseCustomFieldCheckbox.md +++ b/sdks/python/docs/SignatureRequestResponseCustomFieldCheckbox.md @@ -3,13 +3,11 @@ This class extends `SignatureRequestResponseCustomFieldBase`. ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```str``` | The type of this Custom Field. Only 'text' and 'checkbox' are currently supported. | [default to "checkbox"] | | `value` | ```bool``` | A true/false for checkbox fields | | - [[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/sdks/python/docs/SignatureRequestResponseCustomFieldText.md b/sdks/python/docs/SignatureRequestResponseCustomFieldText.md index 520fe0371..c0726b3e5 100644 --- a/sdks/python/docs/SignatureRequestResponseCustomFieldText.md +++ b/sdks/python/docs/SignatureRequestResponseCustomFieldText.md @@ -3,13 +3,11 @@ This class extends `SignatureRequestResponseCustomFieldBase`. ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```str``` | The type of this Custom Field. Only 'text' and 'checkbox' are currently supported. | [default to "text"] | | `value` | ```str``` | A text string for text fields | | - [[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/sdks/python/docs/SignatureRequestResponseCustomFieldTypeEnum.md b/sdks/python/docs/SignatureRequestResponseCustomFieldTypeEnum.md index b2705a846..644955bf8 100644 --- a/sdks/python/docs/SignatureRequestResponseCustomFieldTypeEnum.md +++ b/sdks/python/docs/SignatureRequestResponseCustomFieldTypeEnum.md @@ -3,10 +3,8 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | - +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- [[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/sdks/python/docs/SignatureRequestResponseDataBase.md b/sdks/python/docs/SignatureRequestResponseDataBase.md index 862fcd1f4..e4bf79185 100644 --- a/sdks/python/docs/SignatureRequestResponseDataBase.md +++ b/sdks/python/docs/SignatureRequestResponseDataBase.md @@ -3,16 +3,14 @@ An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers. ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `api_id` | ```str``` | The unique ID for this field. | | | `signature_id` | ```str``` | The ID of the signature to which this response is linked. | | | `name` | ```str``` | The name of the form field. | | | `required` | ```bool``` | A boolean value denoting if this field is required. | | | `type` | ```str``` | | | - [[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/sdks/python/docs/SignatureRequestResponseDataTypeEnum.md b/sdks/python/docs/SignatureRequestResponseDataTypeEnum.md index c0ebf8479..af254fec0 100644 --- a/sdks/python/docs/SignatureRequestResponseDataTypeEnum.md +++ b/sdks/python/docs/SignatureRequestResponseDataTypeEnum.md @@ -3,10 +3,8 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | - +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- [[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/sdks/python/docs/SignatureRequestResponseDataValueCheckbox.md b/sdks/python/docs/SignatureRequestResponseDataValueCheckbox.md index e9a22318c..fcd019c94 100644 --- a/sdks/python/docs/SignatureRequestResponseDataValueCheckbox.md +++ b/sdks/python/docs/SignatureRequestResponseDataValueCheckbox.md @@ -3,13 +3,11 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `type` | ```str``` | A yes/no checkbox | [default to "checkbox"] | | `value` | ```bool``` | The value of the form field. | | - [[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/sdks/python/docs/SignatureRequestResponseDataValueCheckboxMerge.md b/sdks/python/docs/SignatureRequestResponseDataValueCheckboxMerge.md index b4ba1993a..81c9ff8e2 100644 --- a/sdks/python/docs/SignatureRequestResponseDataValueCheckboxMerge.md +++ b/sdks/python/docs/SignatureRequestResponseDataValueCheckboxMerge.md @@ -3,13 +3,11 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `type` | ```str``` | A checkbox field that has default value set by the api | [default to "checkbox-merge"] | | `value` | ```str``` | The value of the form field. | | - [[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/sdks/python/docs/SignatureRequestResponseDataValueDateSigned.md b/sdks/python/docs/SignatureRequestResponseDataValueDateSigned.md index 7b99e63e0..31493c86d 100644 --- a/sdks/python/docs/SignatureRequestResponseDataValueDateSigned.md +++ b/sdks/python/docs/SignatureRequestResponseDataValueDateSigned.md @@ -3,13 +3,11 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `type` | ```str``` | A date | [default to "date_signed"] | | `value` | ```str``` | The value of the form field. | | - [[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/sdks/python/docs/SignatureRequestResponseDataValueDropdown.md b/sdks/python/docs/SignatureRequestResponseDataValueDropdown.md index 20d95a43b..52858147d 100644 --- a/sdks/python/docs/SignatureRequestResponseDataValueDropdown.md +++ b/sdks/python/docs/SignatureRequestResponseDataValueDropdown.md @@ -3,13 +3,11 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `type` | ```str``` | An input field for dropdowns | [default to "dropdown"] | | `value` | ```str``` | The value of the form field. | | - [[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/sdks/python/docs/SignatureRequestResponseDataValueInitials.md b/sdks/python/docs/SignatureRequestResponseDataValueInitials.md index 8d77b11c1..a4104d649 100644 --- a/sdks/python/docs/SignatureRequestResponseDataValueInitials.md +++ b/sdks/python/docs/SignatureRequestResponseDataValueInitials.md @@ -3,13 +3,11 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `type` | ```str``` | An input field for initials | [default to "initials"] | | `value` | ```str``` | The value of the form field. | | - [[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/sdks/python/docs/SignatureRequestResponseDataValueRadio.md b/sdks/python/docs/SignatureRequestResponseDataValueRadio.md index 822697219..f9771954a 100644 --- a/sdks/python/docs/SignatureRequestResponseDataValueRadio.md +++ b/sdks/python/docs/SignatureRequestResponseDataValueRadio.md @@ -3,13 +3,11 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `type` | ```str``` | An input field for radios | [default to "radio"] | | `value` | ```bool``` | The value of the form field. | | - [[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/sdks/python/docs/SignatureRequestResponseDataValueSignature.md b/sdks/python/docs/SignatureRequestResponseDataValueSignature.md index 754bba5e1..78362ff2a 100644 --- a/sdks/python/docs/SignatureRequestResponseDataValueSignature.md +++ b/sdks/python/docs/SignatureRequestResponseDataValueSignature.md @@ -3,13 +3,11 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `type` | ```str``` | A signature input field | [default to "signature"] | | `value` | ```str``` | The value of the form field. | | - [[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/sdks/python/docs/SignatureRequestResponseDataValueText.md b/sdks/python/docs/SignatureRequestResponseDataValueText.md index 0046c5bf7..57bf6e63b 100644 --- a/sdks/python/docs/SignatureRequestResponseDataValueText.md +++ b/sdks/python/docs/SignatureRequestResponseDataValueText.md @@ -3,13 +3,11 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `type` | ```str``` | A text input field | [default to "text"] | | `value` | ```str``` | The value of the form field. | | - [[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/sdks/python/docs/SignatureRequestResponseDataValueTextMerge.md b/sdks/python/docs/SignatureRequestResponseDataValueTextMerge.md index c2ace0b15..4a785d010 100644 --- a/sdks/python/docs/SignatureRequestResponseDataValueTextMerge.md +++ b/sdks/python/docs/SignatureRequestResponseDataValueTextMerge.md @@ -3,13 +3,11 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `type` | ```str``` | A text field that has default text set by the api | [default to "text-merge"] | | `value` | ```str``` | The value of the form field. | | - [[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/sdks/python/docs/SignatureRequestResponseSignatures.md b/sdks/python/docs/SignatureRequestResponseSignatures.md index 913b61eae..e4b2ea246 100644 --- a/sdks/python/docs/SignatureRequestResponseSignatures.md +++ b/sdks/python/docs/SignatureRequestResponseSignatures.md @@ -3,9 +3,8 @@ An array of signature objects, 1 for each signer. ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `signature_id` | ```str``` | Signature identifier. | | | `signer_group_guid` | ```str, none_type``` | Signer Group GUID | | | `signer_email_address` | ```str``` | The email address of the signer. | | @@ -26,7 +25,6 @@ An array of signature objects, 1 for each signer. | `reassigned_from` | ```str, none_type``` | Previous signature identifier. | | | `error` | ```str, none_type``` | Error message pertaining to this signer, or null. | | - [[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/sdks/python/docs/SignatureRequestSendRequest.md b/sdks/python/docs/SignatureRequestSendRequest.md index b72146288..db84b7480 100644 --- a/sdks/python/docs/SignatureRequestSendRequest.md +++ b/sdks/python/docs/SignatureRequestSendRequest.md @@ -3,9 +3,8 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `files` | ```[file_type]``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `file_urls` | ```[str]``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `signers` | [```[SubSignatureRequestSigner]```](SubSignatureRequestSigner.md) | Add Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | @@ -33,7 +32,6 @@ | `use_text_tags` | ```bool``` | Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. | [default to False] | | `expires_at` | ```int, none_type``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | | - [[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/sdks/python/docs/SignatureRequestSendWithTemplateRequest.md b/sdks/python/docs/SignatureRequestSendWithTemplateRequest.md index ccba3f672..e392361a7 100644 --- a/sdks/python/docs/SignatureRequestSendWithTemplateRequest.md +++ b/sdks/python/docs/SignatureRequestSendWithTemplateRequest.md @@ -3,9 +3,8 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `template_ids`*_required_ | ```[str]``` | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. | | | `signers`*_required_ | [```[SubSignatureRequestTemplateSigner]```](SubSignatureRequestTemplateSigner.md) | Add Signers to your Templated-based Signature Request. | | | `allow_decline` | ```bool``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to False] | @@ -24,7 +23,6 @@ | `test_mode` | ```bool``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to False] | | `title` | ```str``` | The title you want to assign to the SignatureRequest. | | - [[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/sdks/python/docs/SignatureRequestUpdateRequest.md b/sdks/python/docs/SignatureRequestUpdateRequest.md index fcca65a4b..501be5ef6 100644 --- a/sdks/python/docs/SignatureRequestUpdateRequest.md +++ b/sdks/python/docs/SignatureRequestUpdateRequest.md @@ -3,15 +3,13 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `signature_id`*_required_ | ```str``` | The signature ID for the recipient. | | | `email_address` | ```str``` | The new email address for the recipient.

This will generate a new `signature_id` value.

**NOTE:** Optional if `name` is provided. | | | `name` | ```str``` | The new name for the recipient.

**NOTE:** Optional if `email_address` is provided. | | | `expires_at` | ```int, none_type``` | The new time when the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | | - [[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/sdks/python/docs/SubAttachment.md b/sdks/python/docs/SubAttachment.md index ebf82d5ab..a8172758e 100644 --- a/sdks/python/docs/SubAttachment.md +++ b/sdks/python/docs/SubAttachment.md @@ -3,15 +3,13 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `name`*_required_ | ```str``` | The name of attachment. | | | `signer_index`*_required_ | ```int``` | The signer's index in the `signers` parameter (0-based indexing).

**NOTE:** Only one signer can be assigned per attachment. | | | `instructions` | ```str``` | The instructions for uploading the attachment. | | | `required` | ```bool``` | Determines if the attachment must be uploaded. | [default to False] | - [[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/sdks/python/docs/SubBulkSignerList.md b/sdks/python/docs/SubBulkSignerList.md index b4e937bd8..d6ad39df4 100644 --- a/sdks/python/docs/SubBulkSignerList.md +++ b/sdks/python/docs/SubBulkSignerList.md @@ -3,13 +3,11 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `custom_fields` | [```[SubBulkSignerListCustomField]```](SubBulkSignerListCustomField.md) | An array of custom field values. | | | `signers` | [```[SubSignatureRequestTemplateSigner]```](SubSignatureRequestTemplateSigner.md) | Add Signers to your Templated-based Signature Request. Allows the requester to specify editor options when a preparing a document.

Currently only templates with a single role are supported. All signers must have the same `role` value. | | - [[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/sdks/python/docs/SubBulkSignerListCustomField.md b/sdks/python/docs/SubBulkSignerListCustomField.md index 079637d97..160180c2a 100644 --- a/sdks/python/docs/SubBulkSignerListCustomField.md +++ b/sdks/python/docs/SubBulkSignerListCustomField.md @@ -3,13 +3,11 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `name`*_required_ | ```str``` | The name of the custom field. Must be the field's `name` or `api_id`. | | | `value`*_required_ | ```str``` | The value of the custom field. | | - [[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/sdks/python/docs/SubCC.md b/sdks/python/docs/SubCC.md index aad785e37..7caebd33b 100644 --- a/sdks/python/docs/SubCC.md +++ b/sdks/python/docs/SubCC.md @@ -3,13 +3,11 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `role`*_required_ | ```str``` | Must match an existing CC role in chosen Template(s). Multiple CC recipients cannot share the same CC role. | | | `email_address`*_required_ | ```str``` | The email address of the CC recipient. | | - [[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/sdks/python/docs/SubCustomField.md b/sdks/python/docs/SubCustomField.md index 7d70ab0d8..bd7fea5b3 100644 --- a/sdks/python/docs/SubCustomField.md +++ b/sdks/python/docs/SubCustomField.md @@ -7,15 +7,13 @@ Pre-filled data can be used with "send-once" signature requests by add For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `name`*_required_ | ```str``` | The name of a custom field. When working with pre-filled data, the custom field's name must have a matching merge field name or the field will remain empty on the document during signing. | | | `editor` | ```str``` | Used to create editable merge fields. When the value matches a role passed in with `signers`, that role can edit the data that was pre-filled to that field. This field is optional, but required when this custom field object is set to `required = true`.

**NOTE:** Editable merge fields are only supported for single signer requests (or the first signer in ordered signature requests). If used when there are multiple signers in an unordered signature request, the editor value is ignored and the field won't be editable. | | | `required` | ```bool``` | Used to set an editable merge field when working with pre-filled data. When `true`, the custom field must specify a signer role in `editor`. | [default to False] | | `value` | ```str``` | The string that resolves (aka "pre-fills") to the merge field on the final document(s) used for signing. | | - [[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/sdks/python/docs/SubEditorOptions.md b/sdks/python/docs/SubEditorOptions.md index 4cf8415a6..81e617bfa 100644 --- a/sdks/python/docs/SubEditorOptions.md +++ b/sdks/python/docs/SubEditorOptions.md @@ -3,13 +3,11 @@ This allows the requester to specify editor options when a preparing a document ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `allow_edit_signers` | ```bool``` | Allows requesters to edit the list of signers | [default to False] | | `allow_edit_documents` | ```bool``` | Allows requesters to edit documents, including delete and add | [default to False] | - [[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/sdks/python/docs/SubFieldOptions.md b/sdks/python/docs/SubFieldOptions.md index ef256c01d..48bedb1f4 100644 --- a/sdks/python/docs/SubFieldOptions.md +++ b/sdks/python/docs/SubFieldOptions.md @@ -3,12 +3,10 @@ This allows the requester to specify field options for a signature request. ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `date_format`*_required_ | ```str``` | Allows requester to specify the date format (see list of allowed [formats](/api/reference/constants/#date-formats))

**NOTE:** Only available for Premium and higher. | | - [[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/sdks/python/docs/SubFormFieldGroup.md b/sdks/python/docs/SubFormFieldGroup.md index ace9c09e4..4e9f630e3 100644 --- a/sdks/python/docs/SubFormFieldGroup.md +++ b/sdks/python/docs/SubFormFieldGroup.md @@ -3,14 +3,12 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `group_id`*_required_ | ```str``` | ID of group. Use this to reference a specific group from the `group` value in `form_fields_per_document`. | | | `group_label`*_required_ | ```str``` | Name of the group | | | `requirement`*_required_ | ```str``` | Examples: `require_0-1` `require_1` `require_1-ormore`

- Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). - Radio groups require **at least** two fields per group. | | - [[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/sdks/python/docs/SubFormFieldRule.md b/sdks/python/docs/SubFormFieldRule.md index 38561d712..36887a152 100644 --- a/sdks/python/docs/SubFormFieldRule.md +++ b/sdks/python/docs/SubFormFieldRule.md @@ -3,15 +3,13 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `id`*_required_ | ```str``` | Must be unique across all defined rules. | | | `trigger_operator`*_required_ | ```str``` | Currently only `AND` is supported. Support for `OR` is being worked on. | [default to "AND"] | | `triggers`*_required_ | [```[SubFormFieldRuleTrigger]```](SubFormFieldRuleTrigger.md) | An array of trigger definitions, the "if this" part of "**if this**, then that". Currently only a single trigger per rule is allowed. | | | `actions`*_required_ | [```[SubFormFieldRuleAction]```](SubFormFieldRuleAction.md) | An array of action definitions, the "then that" part of "if this, **then that**". Any number of actions may be attached to a single rule. | | - [[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/sdks/python/docs/SubFormFieldRuleAction.md b/sdks/python/docs/SubFormFieldRuleAction.md index b0e02baa0..5c53f585a 100644 --- a/sdks/python/docs/SubFormFieldRuleAction.md +++ b/sdks/python/docs/SubFormFieldRuleAction.md @@ -3,15 +3,13 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `hidden`*_required_ | ```bool``` | `true` to hide the target field when rule is satisfied, otherwise `false`. | | | `type`*_required_ | ```str``` | | | | `field_id` | ```str``` | **field_id** or **group_id** is required, but not both.

Must reference the `api_id` of an existing field defined within `form_fields_per_document`.

Cannot use with `group_id`. Trigger and action fields must belong to the same signer. | | | `group_id` | ```str``` | **group_id** or **field_id** is required, but not both.

Must reference the ID of an existing group defined within `form_field_groups`.

Cannot use with `field_id`. Trigger and action fields and groups must belong to the same signer. | | - [[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/sdks/python/docs/SubFormFieldRuleTrigger.md b/sdks/python/docs/SubFormFieldRuleTrigger.md index 3b411c6f7..f1b38ac61 100644 --- a/sdks/python/docs/SubFormFieldRuleTrigger.md +++ b/sdks/python/docs/SubFormFieldRuleTrigger.md @@ -3,15 +3,13 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `id`*_required_ | ```str``` | Must reference the `api_id` of an existing field defined within `form_fields_per_document`. Trigger and action fields and groups must belong to the same signer. | | | `operator`*_required_ | ```str``` | Different field types allow different `operator` values: - Field type of **text**: - **is**: exact match - **not**: not exact match - **match**: regular expression, without /. Example: - OK `[a-zA-Z0-9]` - Not OK `/[a-zA-Z0-9]/` - Field type of **dropdown**: - **is**: exact match, single value - **not**: not exact match, single value - **any**: exact match, array of values. - **none**: not exact match, array of values. - Field type of **checkbox**: - **is**: exact match, single value - **not**: not exact match, single value - Field type of **radio**: - **is**: exact match, single value - **not**: not exact match, single value | | | `value` | ```str``` | **value** or **values** is required, but not both.

The value to match against **operator**.

- When **operator** is one of the following, **value** must be `String`: - `is` - `not` - `match`

Otherwise, - **checkbox**: When **type** of trigger is **checkbox**, **value** must be `0` or `1` - **radio**: When **type** of trigger is **radio**, **value** must be `1` | | | `values` | ```[str]``` | **values** or **value** is required, but not both.

The values to match against **operator** when it is one of the following:

- `any` - `none` | | - [[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/sdks/python/docs/SubFormFieldsPerDocumentBase.md b/sdks/python/docs/SubFormFieldsPerDocumentBase.md index 7e72611b7..2d3d9e8a4 100644 --- a/sdks/python/docs/SubFormFieldsPerDocumentBase.md +++ b/sdks/python/docs/SubFormFieldsPerDocumentBase.md @@ -16,9 +16,8 @@ The fields that should appear on the document, expressed as an array of objects. * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `document_index`*_required_ | ```int``` | Represents the integer index of the `file` or `file_url` document the field should be attached to. | | | `api_id`*_required_ | ```str``` | An identifier for the field that is unique across all documents in the request. | | | `height`*_required_ | ```int``` | Size of the field in pixels. | | @@ -31,7 +30,6 @@ The fields that should appear on the document, expressed as an array of objects. | `name` | ```str``` | Display name for the field. | | | `page` | ```int, none_type``` | Page in the document where the field should be placed (requires documents be PDF files).

- When the page number parameter is supplied, the API will use the new coordinate system. - Check out the differences between both [coordinate systems](https://faq.hellosign.com/hc/en-us/articles/217115577) and how to use them. | | - [[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/sdks/python/docs/SubFormFieldsPerDocumentCheckbox.md b/sdks/python/docs/SubFormFieldsPerDocumentCheckbox.md index 348ea6236..19da7d7e1 100644 --- a/sdks/python/docs/SubFormFieldsPerDocumentCheckbox.md +++ b/sdks/python/docs/SubFormFieldsPerDocumentCheckbox.md @@ -3,14 +3,12 @@ This class extends `SubFormFieldsPerDocumentBase`. ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```str``` | A yes/no checkbox. Use the `SubFormFieldsPerDocumentCheckbox` class. | [default to "checkbox"] | | `is_checked`*_required_ | ```bool``` | `true` for checking the checkbox field by default, otherwise `false`. | | | `group` | ```str``` | String referencing group defined in `form_field_groups` parameter. | | - [[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/sdks/python/docs/SubFormFieldsPerDocumentCheckboxMerge.md b/sdks/python/docs/SubFormFieldsPerDocumentCheckboxMerge.md index 590d4c98f..12331977d 100644 --- a/sdks/python/docs/SubFormFieldsPerDocumentCheckboxMerge.md +++ b/sdks/python/docs/SubFormFieldsPerDocumentCheckboxMerge.md @@ -3,12 +3,10 @@ This class extends `SubFormFieldsPerDocumentBase`. ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```str``` | A checkbox field that has default value set using pre-filled data. Use the `SubFormFieldsPerDocumentCheckboxMerge` class. | [default to "checkbox-merge"] | - [[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/sdks/python/docs/SubFormFieldsPerDocumentDateSigned.md b/sdks/python/docs/SubFormFieldsPerDocumentDateSigned.md index 26cd41b22..d13f5b073 100644 --- a/sdks/python/docs/SubFormFieldsPerDocumentDateSigned.md +++ b/sdks/python/docs/SubFormFieldsPerDocumentDateSigned.md @@ -3,14 +3,12 @@ This class extends `SubFormFieldsPerDocumentBase`. ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```str``` | A date. Use the `SubFormFieldsPerDocumentDateSigned` class. | [default to "date_signed"] | | `font_family` | ```str``` | Font family for the field. | | | `font_size` | ```int``` | The initial px font size for the field contents. Can be any integer value between `7` and `49`.

**NOTE:** Font size may be reduced during processing in order to fit the contents within the dimensions of the field. | [default to 12] | - [[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/sdks/python/docs/SubFormFieldsPerDocumentDropdown.md b/sdks/python/docs/SubFormFieldsPerDocumentDropdown.md index 8a984e7c3..ea838bc00 100644 --- a/sdks/python/docs/SubFormFieldsPerDocumentDropdown.md +++ b/sdks/python/docs/SubFormFieldsPerDocumentDropdown.md @@ -3,16 +3,14 @@ This class extends `SubFormFieldsPerDocumentBase`. ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```str``` | An input field for dropdowns. Use the `SubFormFieldsPerDocumentDropdown` class. | [default to "dropdown"] | | `options`*_required_ | ```[str]``` | Array of string values representing dropdown values. | | | `content` | ```str``` | Selected value in `options` array. Value must exist in array. | | | `font_family` | ```str``` | Font family for the field. | | | `font_size` | ```int``` | The initial px font size for the field contents. Can be any integer value between `7` and `49`.

**NOTE:** Font size may be reduced during processing in order to fit the contents within the dimensions of the field. | [default to 12] | - [[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/sdks/python/docs/SubFormFieldsPerDocumentFontEnum.md b/sdks/python/docs/SubFormFieldsPerDocumentFontEnum.md index 403f882cd..a92e3e2f3 100644 --- a/sdks/python/docs/SubFormFieldsPerDocumentFontEnum.md +++ b/sdks/python/docs/SubFormFieldsPerDocumentFontEnum.md @@ -3,10 +3,8 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | - +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- [[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/sdks/python/docs/SubFormFieldsPerDocumentHyperlink.md b/sdks/python/docs/SubFormFieldsPerDocumentHyperlink.md index 29fa2bdd5..b2029aea5 100644 --- a/sdks/python/docs/SubFormFieldsPerDocumentHyperlink.md +++ b/sdks/python/docs/SubFormFieldsPerDocumentHyperlink.md @@ -3,16 +3,14 @@ This class extends `SubFormFieldsPerDocumentBase`. ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```str``` | A hyperlink field. Use the `SubFormFieldsPerDocumentHyperlink` class. | [default to "hyperlink"] | | `content`*_required_ | ```str``` | Link Text. | | | `content_url`*_required_ | ```str``` | Link URL. | | | `font_family` | ```str``` | Font family for the field. | | | `font_size` | ```int``` | The initial px font size for the field contents. Can be any integer value between `7` and `49`.

**NOTE:** Font size may be reduced during processing in order to fit the contents within the dimensions of the field. | [default to 12] | - [[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/sdks/python/docs/SubFormFieldsPerDocumentInitials.md b/sdks/python/docs/SubFormFieldsPerDocumentInitials.md index b6c01c1f0..c416bc28a 100644 --- a/sdks/python/docs/SubFormFieldsPerDocumentInitials.md +++ b/sdks/python/docs/SubFormFieldsPerDocumentInitials.md @@ -3,12 +3,10 @@ This class extends `SubFormFieldsPerDocumentBase`. ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```str``` | An input field for initials. Use the `SubFormFieldsPerDocumentInitials` class. | [default to "initials"] | - [[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/sdks/python/docs/SubFormFieldsPerDocumentRadio.md b/sdks/python/docs/SubFormFieldsPerDocumentRadio.md index 0a89c862c..a8259b4d1 100644 --- a/sdks/python/docs/SubFormFieldsPerDocumentRadio.md +++ b/sdks/python/docs/SubFormFieldsPerDocumentRadio.md @@ -3,14 +3,12 @@ This class extends `SubFormFieldsPerDocumentBase`. ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```str``` | An input field for radios. Use the `SubFormFieldsPerDocumentRadio` class. | [default to "radio"] | | `group`*_required_ | ```str``` | String referencing group defined in `form_field_groups` parameter. | | | `is_checked`*_required_ | ```bool``` | `true` for checking the radio field by default, otherwise `false`. Only one radio field per group can be `true`. | | - [[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/sdks/python/docs/SubFormFieldsPerDocumentSignature.md b/sdks/python/docs/SubFormFieldsPerDocumentSignature.md index c1d442745..61578e6f0 100644 --- a/sdks/python/docs/SubFormFieldsPerDocumentSignature.md +++ b/sdks/python/docs/SubFormFieldsPerDocumentSignature.md @@ -3,12 +3,10 @@ This class extends `SubFormFieldsPerDocumentBase`. ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```str``` | A signature input field. Use the `SubFormFieldsPerDocumentSignature` class. | [default to "signature"] | - [[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/sdks/python/docs/SubFormFieldsPerDocumentText.md b/sdks/python/docs/SubFormFieldsPerDocumentText.md index e0ddbf478..607671930 100644 --- a/sdks/python/docs/SubFormFieldsPerDocumentText.md +++ b/sdks/python/docs/SubFormFieldsPerDocumentText.md @@ -3,9 +3,8 @@ This class extends `SubFormFieldsPerDocumentBase`. ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```str``` | A text input field. Use the `SubFormFieldsPerDocumentText` class. | [default to "text"] | | `placeholder` | ```str``` | Placeholder value for text field. | | | `auto_fill_type` | ```str``` | Auto fill type for populating fields automatically. Check out the list of [auto fill types](/api/reference/constants/#auto-fill-types) to learn more about the possible values. | | @@ -18,7 +17,6 @@ This class extends `SubFormFieldsPerDocumentBase`. | `font_family` | ```str``` | Font family for the field. | | | `font_size` | ```int``` | The initial px font size for the field contents. Can be any integer value between `7` and `49`.

**NOTE:** Font size may be reduced during processing in order to fit the contents within the dimensions of the field. | [default to 12] | - [[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/sdks/python/docs/SubFormFieldsPerDocumentTextMerge.md b/sdks/python/docs/SubFormFieldsPerDocumentTextMerge.md index 8bee2e6b2..d56e086f4 100644 --- a/sdks/python/docs/SubFormFieldsPerDocumentTextMerge.md +++ b/sdks/python/docs/SubFormFieldsPerDocumentTextMerge.md @@ -3,14 +3,12 @@ This class extends `SubFormFieldsPerDocumentBase`. ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```str``` | A text field that has default text set using pre-filled data. Use the `SubFormFieldsPerDocumentTextMerge` class. | [default to "text-merge"] | | `font_family` | ```str``` | Font family for the field. | | | `font_size` | ```int``` | The initial px font size for the field contents. Can be any integer value between `7` and `49`.

**NOTE:** Font size may be reduced during processing in order to fit the contents within the dimensions of the field. | [default to 12] | - [[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/sdks/python/docs/SubFormFieldsPerDocumentTypeEnum.md b/sdks/python/docs/SubFormFieldsPerDocumentTypeEnum.md index 598090cba..37bac7dd0 100644 --- a/sdks/python/docs/SubFormFieldsPerDocumentTypeEnum.md +++ b/sdks/python/docs/SubFormFieldsPerDocumentTypeEnum.md @@ -3,10 +3,8 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | - +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- [[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/sdks/python/docs/SubMergeField.md b/sdks/python/docs/SubMergeField.md index 41fdec5ca..be4dfd7cf 100644 --- a/sdks/python/docs/SubMergeField.md +++ b/sdks/python/docs/SubMergeField.md @@ -3,13 +3,11 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `name`*_required_ | ```str``` | The name of the merge field. Must be unique. | | | `type`*_required_ | ```str``` | The type of merge field. | | - [[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/sdks/python/docs/SubOAuth.md b/sdks/python/docs/SubOAuth.md index 5c9905971..589654016 100644 --- a/sdks/python/docs/SubOAuth.md +++ b/sdks/python/docs/SubOAuth.md @@ -3,13 +3,11 @@ OAuth related parameters. ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `callback_url` | ```str``` | The callback URL to be used for OAuth flows. (Required if `oauth[scopes]` is provided) | | | `scopes` | ```[str]``` | A list of [OAuth scopes](/api/reference/tag/OAuth) to be granted to the app. (Required if `oauth[callback_url]` is provided). | | - [[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/sdks/python/docs/SubOptions.md b/sdks/python/docs/SubOptions.md index be7b7d599..871dc60b6 100644 --- a/sdks/python/docs/SubOptions.md +++ b/sdks/python/docs/SubOptions.md @@ -3,12 +3,10 @@ Additional options supported by API App. ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `can_insert_everywhere` | ```bool``` | Determines if signers can use "Insert Everywhere" when signing a document. | [default to False] | - [[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/sdks/python/docs/SubSignatureRequestGroupedSigners.md b/sdks/python/docs/SubSignatureRequestGroupedSigners.md index 83f8e90d4..d90b636f3 100644 --- a/sdks/python/docs/SubSignatureRequestGroupedSigners.md +++ b/sdks/python/docs/SubSignatureRequestGroupedSigners.md @@ -3,14 +3,12 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `group`*_required_ | ```str``` | The name of the group. | | | `signers`*_required_ | [```[SubSignatureRequestSigner]```](SubSignatureRequestSigner.md) | Signers belonging to this Group.

**NOTE:** Only `name`, `email_address`, and `pin` are available to Grouped Signers. We will ignore all other properties, even though they are listed below. | | | `order` | ```int, none_type``` | The order the group is required to sign in. Use this instead of Signer-level `order`. | | - [[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/sdks/python/docs/SubSignatureRequestSigner.md b/sdks/python/docs/SubSignatureRequestSigner.md index 731887c46..7a295c115 100644 --- a/sdks/python/docs/SubSignatureRequestSigner.md +++ b/sdks/python/docs/SubSignatureRequestSigner.md @@ -3,9 +3,8 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `name`*_required_ | ```str``` | The name of the signer. | | | `email_address`*_required_ | ```str``` | The email address of the signer. | | | `order` | ```int, none_type``` | The order the signer is required to sign in. | | @@ -13,7 +12,6 @@ | `sms_phone_number` | ```str``` | An E.164 formatted phone number.

By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on).

**NOTE:** Not available in test mode and requires a Standard plan or higher. | | | `sms_phone_number_type` | ```str``` | Specifies the feature used with the `sms_phone_number`. Default `authentication`.

If `authentication`, signer is sent a verification code via SMS that is required to access the document.

If `delivery`, a link to complete the signature request is delivered via SMS (_and_ email). | | - [[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/sdks/python/docs/SubSignatureRequestTemplateSigner.md b/sdks/python/docs/SubSignatureRequestTemplateSigner.md index 94596aac2..392204b1c 100644 --- a/sdks/python/docs/SubSignatureRequestTemplateSigner.md +++ b/sdks/python/docs/SubSignatureRequestTemplateSigner.md @@ -3,9 +3,8 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `role`*_required_ | ```str``` | Must match an existing role in chosen Template(s). It's case-sensitive. | | | `name`*_required_ | ```str``` | The name of the signer. | | | `email_address`*_required_ | ```str``` | The email address of the signer. | | @@ -13,7 +12,6 @@ | `sms_phone_number` | ```str``` | An E.164 formatted phone number.

By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on).

**NOTE:** Not available in test mode and requires a Standard plan or higher. | | | `sms_phone_number_type` | ```str``` | Specifies the feature used with the `sms_phone_number`. Default `authentication`.

If `authentication`, signer is sent a verification code via SMS that is required to access the document.

If `delivery`, a link to complete the signature request is delivered via SMS (_and_ email). | | - [[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/sdks/python/docs/SubSigningOptions.md b/sdks/python/docs/SubSigningOptions.md index 0c13e4cb4..9584478ec 100644 --- a/sdks/python/docs/SubSigningOptions.md +++ b/sdks/python/docs/SubSigningOptions.md @@ -5,16 +5,14 @@ This allows the requester to specify the types allowed for creating a signature. **NOTE:** If `signing_options` are not defined in the request, the allowed types will default to those specified in the account settings. ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `default_type`*_required_ | ```str``` | The default type shown (limited to the listed types) | | | `draw` | ```bool``` | Allows drawing the signature | [default to False] | | `phone` | ```bool``` | Allows using a smartphone to email the signature | [default to False] | | `type` | ```bool``` | Allows typing the signature | [default to False] | | `upload` | ```bool``` | Allows uploading the signature | [default to False] | - [[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/sdks/python/docs/SubTeamResponse.md b/sdks/python/docs/SubTeamResponse.md index a41fc55f7..750829a35 100644 --- a/sdks/python/docs/SubTeamResponse.md +++ b/sdks/python/docs/SubTeamResponse.md @@ -3,13 +3,11 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `team_id` | ```str``` | The id of a team | | | `name` | ```str``` | The name of a team | | - [[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/sdks/python/docs/SubTemplateRole.md b/sdks/python/docs/SubTemplateRole.md index 196dd8939..4d98e08cd 100644 --- a/sdks/python/docs/SubTemplateRole.md +++ b/sdks/python/docs/SubTemplateRole.md @@ -3,13 +3,11 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `name` | ```str``` | The role name of the signer that will be displayed when the template is used to create a signature request. | | | `order` | ```int, none_type``` | The order in which this signer role is required to sign. | | - [[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/sdks/python/docs/SubUnclaimedDraftSigner.md b/sdks/python/docs/SubUnclaimedDraftSigner.md index 731cba206..0ebb34ab3 100644 --- a/sdks/python/docs/SubUnclaimedDraftSigner.md +++ b/sdks/python/docs/SubUnclaimedDraftSigner.md @@ -3,14 +3,12 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `email_address`*_required_ | ```str``` | The email address of the signer. | | | `name`*_required_ | ```str``` | The name of the signer. | | | `order` | ```int, none_type``` | The order the signer is required to sign in. | | - [[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/sdks/python/docs/SubUnclaimedDraftTemplateSigner.md b/sdks/python/docs/SubUnclaimedDraftTemplateSigner.md index e8df5f38c..80634e817 100644 --- a/sdks/python/docs/SubUnclaimedDraftTemplateSigner.md +++ b/sdks/python/docs/SubUnclaimedDraftTemplateSigner.md @@ -3,14 +3,12 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `role`*_required_ | ```str``` | Must match an existing role in chosen Template(s). | | | `name`*_required_ | ```str``` | The name of the signer filling the role of `role`. | | | `email_address`*_required_ | ```str``` | The email address of the signer filling the role of `role`. | | - [[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/sdks/python/docs/SubWhiteLabelingOptions.md b/sdks/python/docs/SubWhiteLabelingOptions.md index 1b63f2d5f..bbf774879 100644 --- a/sdks/python/docs/SubWhiteLabelingOptions.md +++ b/sdks/python/docs/SubWhiteLabelingOptions.md @@ -5,9 +5,8 @@ An array of elements and values serialized to a string, to be used to customize Take a look at our [white labeling guide](https://developers.hellosign.com/api/reference/premium-branding/) to learn more. ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `header_background_color` | ```str``` | | [default to "#1A1A1A"] | | `legal_version` | ```str``` | | [default to "terms1"] | | `link_color` | ```str``` | | [default to "#00B3E6"] | @@ -24,7 +23,6 @@ Take a look at our [white labeling guide](https://developers.hellosign.com/api/r | `text_color2` | ```str``` | | [default to "#FFFFFF"] | | `reset_to_default` | ```bool``` | Resets white labeling options to defaults. Only useful when updating an API App. | | - [[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/sdks/python/docs/TeamAddMemberRequest.md b/sdks/python/docs/TeamAddMemberRequest.md index 40d3ee739..a40c8b178 100644 --- a/sdks/python/docs/TeamAddMemberRequest.md +++ b/sdks/python/docs/TeamAddMemberRequest.md @@ -3,14 +3,12 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `account_id` | ```str``` | `account_id` or `email_address` is required. If both are provided, the account id prevails.

Account id of the user to invite to your Team. | | | `email_address` | ```str``` | `account_id` or `email_address` is required, If both are provided, the account id prevails.

Email address of the user to invite to your Team. | | | `role` | ```str``` | A role member will take in a new Team.

**NOTE:** This parameter is used only if `team_id` is provided. | | - [[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/sdks/python/docs/TeamApi.md b/sdks/python/docs/TeamApi.md index 8f4318ed3..da3664e6a 100644 --- a/sdks/python/docs/TeamApi.md +++ b/sdks/python/docs/TeamApi.md @@ -2,8 +2,8 @@ All URIs are relative to *https://api.hellosign.com/v3* -|Method | HTTP request | Description| -|------------- | ------------- | -------------| +Method | HTTP request | Description +------------- | ------------- | ------------- |[```team_add_member```](TeamApi.md#team_add_member) | ```PUT /team/add_member``` | Add User to Team| |[```team_create```](TeamApi.md#team_create) | ```POST /team/create``` | Create Team| |[```team_delete```](TeamApi.md#team_delete) | ```DELETE /team/destroy``` | Delete Team| @@ -59,7 +59,6 @@ with ApiClient(configuration) as api_client: ### Parameters - | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `team_add_member_request` | [**TeamAddMemberRequest**](TeamAddMemberRequest.md) | | | @@ -131,7 +130,6 @@ with ApiClient(configuration) as api_client: ### Parameters - | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `team_create_request` | [**TeamCreateRequest**](TeamCreateRequest.md) | | | @@ -195,7 +193,6 @@ with ApiClient(configuration) as api_client: ### Parameters - This endpoint does not need any parameter. ### Return type @@ -260,7 +257,6 @@ with ApiClient(configuration) as api_client: ### Parameters - This endpoint does not need any parameter. ### Return type @@ -325,7 +321,6 @@ with ApiClient(configuration) as api_client: ### Parameters - | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `team_id` | **str** | The id of the team. | [optional] | @@ -394,7 +389,6 @@ with ApiClient(configuration) as api_client: ### Parameters - | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `email_address` | **str** | The email address for which to display the team invites. | [optional] | @@ -463,7 +457,6 @@ with ApiClient(configuration) as api_client: ### Parameters - | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `team_id` | **str** | The id of the team that a member list is being requested from. | | @@ -537,7 +530,6 @@ with ApiClient(configuration) as api_client: ### Parameters - | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `team_remove_member_request` | [**TeamRemoveMemberRequest**](TeamRemoveMemberRequest.md) | | | @@ -606,7 +598,6 @@ with ApiClient(configuration) as api_client: ### Parameters - | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `team_id` | **str** | The id of the parent Team. | | @@ -679,7 +670,6 @@ with ApiClient(configuration) as api_client: ### Parameters - | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `team_update_request` | [**TeamUpdateRequest**](TeamUpdateRequest.md) | | | diff --git a/sdks/python/docs/TeamCreateRequest.md b/sdks/python/docs/TeamCreateRequest.md index 132a1a36e..9d238b41b 100644 --- a/sdks/python/docs/TeamCreateRequest.md +++ b/sdks/python/docs/TeamCreateRequest.md @@ -3,12 +3,10 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `name` | ```str``` | The name of your Team. | [default to "Untitled Team"] | - [[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/sdks/python/docs/TeamGetInfoResponse.md b/sdks/python/docs/TeamGetInfoResponse.md index aecd9518a..a9b6ef222 100644 --- a/sdks/python/docs/TeamGetInfoResponse.md +++ b/sdks/python/docs/TeamGetInfoResponse.md @@ -3,13 +3,11 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `team` | [```TeamInfoResponse```](TeamInfoResponse.md) | | | | `warnings` | [```[WarningResponse]```](WarningResponse.md) | A list of warnings. | | - [[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/sdks/python/docs/TeamGetResponse.md b/sdks/python/docs/TeamGetResponse.md index cc950e7fc..a99404f1d 100644 --- a/sdks/python/docs/TeamGetResponse.md +++ b/sdks/python/docs/TeamGetResponse.md @@ -3,13 +3,11 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `team` | [```TeamResponse```](TeamResponse.md) | | | | `warnings` | [```[WarningResponse]```](WarningResponse.md) | A list of warnings. | | - [[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/sdks/python/docs/TeamInfoResponse.md b/sdks/python/docs/TeamInfoResponse.md index 3d19173d2..ee8991007 100644 --- a/sdks/python/docs/TeamInfoResponse.md +++ b/sdks/python/docs/TeamInfoResponse.md @@ -3,16 +3,14 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `team_id` | ```str``` | The id of a team | | | `team_parent` | [```TeamParentResponse```](TeamParentResponse.md) | | | | `name` | ```str``` | The name of a team | | | `num_members` | ```int``` | Number of members within a team | | | `num_sub_teams` | ```int``` | Number of sub teams within a team | | - [[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/sdks/python/docs/TeamInviteResponse.md b/sdks/python/docs/TeamInviteResponse.md index 8c7cf802b..24b95e3f3 100644 --- a/sdks/python/docs/TeamInviteResponse.md +++ b/sdks/python/docs/TeamInviteResponse.md @@ -3,9 +3,8 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `email_address` | ```str``` | Email address of the user invited to this team. | | | `team_id` | ```str``` | Id of the team. | | | `role` | ```str``` | Role of the user invited to this team. | | @@ -13,7 +12,6 @@ | `redeemed_at` | ```int``` | Timestamp when the invitation was redeemed. | | | `expires_at` | ```int``` | Timestamp when the invitation is expiring. | | - [[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/sdks/python/docs/TeamInvitesResponse.md b/sdks/python/docs/TeamInvitesResponse.md index 58eda2899..78b4d80c0 100644 --- a/sdks/python/docs/TeamInvitesResponse.md +++ b/sdks/python/docs/TeamInvitesResponse.md @@ -3,13 +3,11 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `team_invites` | [```[TeamInviteResponse]```](TeamInviteResponse.md) | Contains a list of team invites and their roles. | | | `warnings` | [```[WarningResponse]```](WarningResponse.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/sdks/python/docs/TeamMemberResponse.md b/sdks/python/docs/TeamMemberResponse.md index d6ed7c830..64fea4347 100644 --- a/sdks/python/docs/TeamMemberResponse.md +++ b/sdks/python/docs/TeamMemberResponse.md @@ -3,14 +3,12 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `account_id` | ```str``` | Account id of the team member. | | | `email_address` | ```str``` | Email address of the team member. | | | `role` | ```str``` | The specific role a member has on the team. | | - [[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/sdks/python/docs/TeamMembersResponse.md b/sdks/python/docs/TeamMembersResponse.md index 2fadc892a..7d44711eb 100644 --- a/sdks/python/docs/TeamMembersResponse.md +++ b/sdks/python/docs/TeamMembersResponse.md @@ -3,14 +3,12 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `team_members` | [```[TeamMemberResponse]```](TeamMemberResponse.md) | Contains a list of team members and their roles for a specific team. | | | `list_info` | [```ListInfoResponse```](ListInfoResponse.md) | | | | `warnings` | [```[WarningResponse]```](WarningResponse.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/sdks/python/docs/TeamParentResponse.md b/sdks/python/docs/TeamParentResponse.md index c1347cd0c..ba3f06dd2 100644 --- a/sdks/python/docs/TeamParentResponse.md +++ b/sdks/python/docs/TeamParentResponse.md @@ -3,13 +3,11 @@ Information about the parent team if a team has one, set to `null` otherwise. ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `team_id` | ```str``` | The id of a team | | | `name` | ```str``` | The name of a team | | - [[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/sdks/python/docs/TeamRemoveMemberRequest.md b/sdks/python/docs/TeamRemoveMemberRequest.md index 7cc6c70ff..8369af840 100644 --- a/sdks/python/docs/TeamRemoveMemberRequest.md +++ b/sdks/python/docs/TeamRemoveMemberRequest.md @@ -3,16 +3,14 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `account_id` | ```str``` | **account_id** or **email_address** is required. If both are provided, the account id prevails.

Account id to remove from your Team. | | | `email_address` | ```str``` | **account_id** or **email_address** is required. If both are provided, the account id prevails.

Email address of the Account to remove from your Team. | | | `new_owner_email_address` | ```str``` | The email address of an Account on this Team to receive all documents, templates, and API apps (if applicable) from the removed Account. If not provided, and on an Enterprise plan, this data will remain with the removed Account.

**NOTE:** Only available for Enterprise plans. | | | `new_team_id` | ```str``` | Id of the new Team. | | | `new_role` | ```str``` | A new role member will take in a new Team.

**NOTE:** This parameter is used only if `new_team_id` is provided. | | - [[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/sdks/python/docs/TeamResponse.md b/sdks/python/docs/TeamResponse.md index dc1fadc47..b3f41be03 100644 --- a/sdks/python/docs/TeamResponse.md +++ b/sdks/python/docs/TeamResponse.md @@ -3,15 +3,13 @@ Contains information about your team and its members ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `name` | ```str``` | The name of your Team | | | `accounts` | [```[AccountResponse]```](AccountResponse.md) | | | | `invited_accounts` | [```[AccountResponse]```](AccountResponse.md) | A list of all Accounts that have an outstanding invitation to join your Team. Note that this response is a subset of the response parameters found in `GET /account`. | | | `invited_emails` | ```[str]``` | A list of email addresses that have an outstanding invitation to join your Team and do not yet have a Dropbox Sign account. | | - [[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/sdks/python/docs/TeamSubTeamsResponse.md b/sdks/python/docs/TeamSubTeamsResponse.md index afd481b20..1b7f9f89f 100644 --- a/sdks/python/docs/TeamSubTeamsResponse.md +++ b/sdks/python/docs/TeamSubTeamsResponse.md @@ -3,14 +3,12 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `sub_teams` | [```[SubTeamResponse]```](SubTeamResponse.md) | Contains a list with sub teams. | | | `list_info` | [```ListInfoResponse```](ListInfoResponse.md) | | | | `warnings` | [```[WarningResponse]```](WarningResponse.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/sdks/python/docs/TeamUpdateRequest.md b/sdks/python/docs/TeamUpdateRequest.md index 56cf99980..d99b6a5ec 100644 --- a/sdks/python/docs/TeamUpdateRequest.md +++ b/sdks/python/docs/TeamUpdateRequest.md @@ -3,12 +3,10 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `name` | ```str``` | The name of your Team. | | - [[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/sdks/python/docs/TemplateAddUserRequest.md b/sdks/python/docs/TemplateAddUserRequest.md index d3adc205c..08a2ac117 100644 --- a/sdks/python/docs/TemplateAddUserRequest.md +++ b/sdks/python/docs/TemplateAddUserRequest.md @@ -3,14 +3,12 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `account_id` | ```str``` | The id of the Account to give access to the Template.
**NOTE:** The account id prevails if email address is also provided. | | | `email_address` | ```str``` | The email address of the Account to give access to the Template.
**NOTE:** The account id prevails if it is also provided. | | | `skip_notification` | ```bool``` | If set to `true`, the user does not receive an email notification when a template has been shared with them. Defaults to `false`. | [default to False] | - [[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/sdks/python/docs/TemplateApi.md b/sdks/python/docs/TemplateApi.md index 6651a7c25..15c878aa7 100644 --- a/sdks/python/docs/TemplateApi.md +++ b/sdks/python/docs/TemplateApi.md @@ -2,8 +2,8 @@ All URIs are relative to *https://api.hellosign.com/v3* -|Method | HTTP request | Description| -|------------- | ------------- | -------------| +Method | HTTP request | Description +------------- | ------------- | ------------- |[```template_add_user```](TemplateApi.md#template_add_user) | ```POST /template/add_user/{template_id}``` | Add User to Template| |[```template_create```](TemplateApi.md#template_create) | ```POST /template/create``` | Create Template| |[```template_create_embedded_draft```](TemplateApi.md#template_create_embedded_draft) | ```POST /template/create_embedded_draft``` | Create Embedded Template Draft| @@ -62,7 +62,6 @@ with ApiClient(configuration) as api_client: ### Parameters - | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `template_id` | **str** | The id of the Template to give the Account access to. | | @@ -167,7 +166,6 @@ with ApiClient(configuration) as api_client: ### Parameters - | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `template_create_request` | [**TemplateCreateRequest**](TemplateCreateRequest.md) | | | @@ -271,7 +269,6 @@ with ApiClient(configuration) as api_client: ### Parameters - | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `template_create_embedded_draft_request` | [**TemplateCreateEmbeddedDraftRequest**](TemplateCreateEmbeddedDraftRequest.md) | | | @@ -337,7 +334,6 @@ with ApiClient(configuration) as api_client: ### Parameters - | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `template_id` | **str** | The id of the Template to delete. | | @@ -406,7 +402,6 @@ with ApiClient(configuration) as api_client: ### Parameters - | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `template_id` | **str** | The id of the template files to retrieve. | | @@ -476,7 +471,6 @@ with ApiClient(configuration) as api_client: ### Parameters - | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `template_id` | **str** | The id of the template files to retrieve. | | @@ -545,7 +539,6 @@ with ApiClient(configuration) as api_client: ### Parameters - | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `template_id` | **str** | The id of the template files to retrieve. | | @@ -615,7 +608,6 @@ with ApiClient(configuration) as api_client: ### Parameters - | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `template_id` | **str** | The id of the Template to retrieve. | | @@ -686,7 +678,6 @@ with ApiClient(configuration) as api_client: ### Parameters - | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `account_id` | **str** | Which account to return Templates for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. | [optional] | @@ -762,7 +753,6 @@ with ApiClient(configuration) as api_client: ### Parameters - | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `template_id` | **str** | The id of the Template to remove the Account's access to. | | @@ -836,7 +826,6 @@ with ApiClient(configuration) as api_client: ### Parameters - | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `template_id` | **str** | The ID of the template whose files to update. | | diff --git a/sdks/python/docs/TemplateCreateEmbeddedDraftRequest.md b/sdks/python/docs/TemplateCreateEmbeddedDraftRequest.md index db0ae9828..d495ce46b 100644 --- a/sdks/python/docs/TemplateCreateEmbeddedDraftRequest.md +++ b/sdks/python/docs/TemplateCreateEmbeddedDraftRequest.md @@ -3,9 +3,8 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `client_id`*_required_ | ```str``` | Client id of the app you're using to create this draft. Used to apply the branding and callback url defined for the app. | | | `files` | ```[file_type]``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `file_urls` | ```[str]``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | @@ -32,7 +31,6 @@ | `title` | ```str``` | The title you want to assign to the SignatureRequest. | | | `use_preexisting_fields` | ```bool``` | Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). | [default to False] | - [[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/sdks/python/docs/TemplateCreateEmbeddedDraftResponse.md b/sdks/python/docs/TemplateCreateEmbeddedDraftResponse.md index 3014a273b..55b55f700 100644 --- a/sdks/python/docs/TemplateCreateEmbeddedDraftResponse.md +++ b/sdks/python/docs/TemplateCreateEmbeddedDraftResponse.md @@ -3,13 +3,11 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `template` | [```TemplateCreateEmbeddedDraftResponseTemplate```](TemplateCreateEmbeddedDraftResponseTemplate.md) | | | | `warnings` | [```[WarningResponse]```](WarningResponse.md) | A list of warnings. | | - [[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/sdks/python/docs/TemplateCreateEmbeddedDraftResponseTemplate.md b/sdks/python/docs/TemplateCreateEmbeddedDraftResponseTemplate.md index 254517242..299318265 100644 --- a/sdks/python/docs/TemplateCreateEmbeddedDraftResponseTemplate.md +++ b/sdks/python/docs/TemplateCreateEmbeddedDraftResponseTemplate.md @@ -3,15 +3,13 @@ Template object with parameters: `template_id`, `edit_url`, `expires_at`. ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `template_id` | ```str``` | The id of the Template. | | | `edit_url` | ```str``` | Link to edit the template. | | | `expires_at` | ```int``` | When the link expires. | | | `warnings` | [```[WarningResponse]```](WarningResponse.md) | A list of warnings. | | - [[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/sdks/python/docs/TemplateCreateRequest.md b/sdks/python/docs/TemplateCreateRequest.md index b79634a44..44d7c33eb 100644 --- a/sdks/python/docs/TemplateCreateRequest.md +++ b/sdks/python/docs/TemplateCreateRequest.md @@ -3,9 +3,8 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `form_fields_per_document`*_required_ | [```[SubFormFieldsPerDocumentBase]```](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)

**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.

* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
* Radio Field use `SubFormFieldsPerDocumentRadio`
* Signature Field use `SubFormFieldsPerDocumentSignature`
* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
* Initials Field use `SubFormFieldsPerDocumentInitials`
* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | | | `signer_roles`*_required_ | [```[SubTemplateRole]```](SubTemplateRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | | | `files` | ```[file_type]``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | @@ -25,7 +24,6 @@ | `title` | ```str``` | The title you want to assign to the SignatureRequest. | | | `use_preexisting_fields` | ```bool``` | Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). | [default to False] | - [[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/sdks/python/docs/TemplateCreateResponse.md b/sdks/python/docs/TemplateCreateResponse.md index 742a854c6..663bed62c 100644 --- a/sdks/python/docs/TemplateCreateResponse.md +++ b/sdks/python/docs/TemplateCreateResponse.md @@ -3,13 +3,11 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `template` | [```TemplateCreateResponseTemplate```](TemplateCreateResponseTemplate.md) | | | | `warnings` | [```[WarningResponse]```](WarningResponse.md) | A list of warnings. | | - [[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/sdks/python/docs/TemplateCreateResponseTemplate.md b/sdks/python/docs/TemplateCreateResponseTemplate.md index a26dab427..21d6307c7 100644 --- a/sdks/python/docs/TemplateCreateResponseTemplate.md +++ b/sdks/python/docs/TemplateCreateResponseTemplate.md @@ -3,12 +3,10 @@ Template object with parameters: `template_id`. ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `template_id` | ```str``` | The id of the Template. | | - [[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/sdks/python/docs/TemplateEditResponse.md b/sdks/python/docs/TemplateEditResponse.md index d4405b397..30dcd803a 100644 --- a/sdks/python/docs/TemplateEditResponse.md +++ b/sdks/python/docs/TemplateEditResponse.md @@ -3,12 +3,10 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `template_id` | ```str``` | The id of the Template. | | - [[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/sdks/python/docs/TemplateGetResponse.md b/sdks/python/docs/TemplateGetResponse.md index 2e72a1565..6f29c8bf0 100644 --- a/sdks/python/docs/TemplateGetResponse.md +++ b/sdks/python/docs/TemplateGetResponse.md @@ -3,13 +3,11 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `template` | [```TemplateResponse```](TemplateResponse.md) | | | | `warnings` | [```[WarningResponse]```](WarningResponse.md) | A list of warnings. | | - [[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/sdks/python/docs/TemplateListResponse.md b/sdks/python/docs/TemplateListResponse.md index 305855f4c..14878d126 100644 --- a/sdks/python/docs/TemplateListResponse.md +++ b/sdks/python/docs/TemplateListResponse.md @@ -3,14 +3,12 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `templates` | [```[TemplateResponse]```](TemplateResponse.md) | List of templates that the API caller has access to. | | | `list_info` | [```ListInfoResponse```](ListInfoResponse.md) | | | | `warnings` | [```[WarningResponse]```](WarningResponse.md) | A list of warnings. | | - [[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/sdks/python/docs/TemplateRemoveUserRequest.md b/sdks/python/docs/TemplateRemoveUserRequest.md index a4782eb10..c151a0bef 100644 --- a/sdks/python/docs/TemplateRemoveUserRequest.md +++ b/sdks/python/docs/TemplateRemoveUserRequest.md @@ -3,13 +3,11 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `account_id` | ```str``` | The id or email address of the Account to remove access to the Template. The account id prevails if both are provided. | | | `email_address` | ```str``` | The id or email address of the Account to remove access to the Template. The account id prevails if both are provided. | | - [[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/sdks/python/docs/TemplateResponse.md b/sdks/python/docs/TemplateResponse.md index 4da804789..bb26bb762 100644 --- a/sdks/python/docs/TemplateResponse.md +++ b/sdks/python/docs/TemplateResponse.md @@ -3,9 +3,8 @@ Contains information about the templates you and your team have created. ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `template_id` | ```str``` | The id of the Template. | | | `title` | ```str``` | The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | | | `message` | ```str``` | The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | | @@ -22,7 +21,6 @@ Contains information about the templates you and your team have created. | `named_form_fields` | [```[TemplateResponseDocumentFormFieldBase], none_type```](TemplateResponseDocumentFormFieldBase.md) | Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | | | `accounts` | [```[TemplateResponseAccount], none_type```](TemplateResponseAccount.md) | An array of the Accounts that can use this Template. | | - [[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/sdks/python/docs/TemplateResponseAccount.md b/sdks/python/docs/TemplateResponseAccount.md index ea5942df8..e991a4092 100644 --- a/sdks/python/docs/TemplateResponseAccount.md +++ b/sdks/python/docs/TemplateResponseAccount.md @@ -3,9 +3,8 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `account_id` | ```str``` | The id of the Account. | | | `email_address` | ```str``` | The email address associated with the Account. | | | `is_locked` | ```bool``` | Returns `true` if the user has been locked out of their account by a team admin. | | @@ -13,7 +12,6 @@ | `is_paid_hf` | ```bool``` | Returns `true` if the user has a paid HelloFax account. | | | `quotas` | [```TemplateResponseAccountQuota```](TemplateResponseAccountQuota.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/sdks/python/docs/TemplateResponseAccountQuota.md b/sdks/python/docs/TemplateResponseAccountQuota.md index 3a3cbb9e4..1af33065a 100644 --- a/sdks/python/docs/TemplateResponseAccountQuota.md +++ b/sdks/python/docs/TemplateResponseAccountQuota.md @@ -3,15 +3,13 @@ An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `templates_left` | ```int``` | API templates remaining. | | | `api_signature_requests_left` | ```int``` | API signature requests remaining. | | | `documents_left` | ```int``` | Signature requests remaining. | | | `sms_verifications_left` | ```int``` | SMS verifications remaining. | | - [[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/sdks/python/docs/TemplateResponseCCRole.md b/sdks/python/docs/TemplateResponseCCRole.md index 3f963b6d0..68b6feafe 100644 --- a/sdks/python/docs/TemplateResponseCCRole.md +++ b/sdks/python/docs/TemplateResponseCCRole.md @@ -3,12 +3,10 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `name` | ```str``` | The name of the Role. | | - [[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/sdks/python/docs/TemplateResponseDocument.md b/sdks/python/docs/TemplateResponseDocument.md index d45af8ee6..760ab54b2 100644 --- a/sdks/python/docs/TemplateResponseDocument.md +++ b/sdks/python/docs/TemplateResponseDocument.md @@ -3,9 +3,8 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `name` | ```str``` | Name of the associated file. | | | `index` | ```int``` | Document ordering, the lowest index is displayed first and the highest last (0-based indexing). | | | `field_groups` | [```[TemplateResponseDocumentFieldGroup]```](TemplateResponseDocumentFieldGroup.md) | An array of Form Field Group objects. | | @@ -13,7 +12,6 @@ | `custom_fields` | [```[TemplateResponseDocumentCustomFieldBase]```](TemplateResponseDocumentCustomFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | | | `static_fields` | [```[TemplateResponseDocumentStaticFieldBase], none_type```](TemplateResponseDocumentStaticFieldBase.md) | An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. | | - [[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/sdks/python/docs/TemplateResponseDocumentCustomFieldBase.md b/sdks/python/docs/TemplateResponseDocumentCustomFieldBase.md index c05c9f7a2..aa31b88ae 100644 --- a/sdks/python/docs/TemplateResponseDocumentCustomFieldBase.md +++ b/sdks/python/docs/TemplateResponseDocumentCustomFieldBase.md @@ -3,9 +3,8 @@ An array of Form Field objects containing the name and type of each named field. ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```str``` | | | | `api_id` | ```str``` | The unique ID for this field. | | | `name` | ```str``` | The name of the Custom Field. | | @@ -17,7 +16,6 @@ An array of Form Field objects containing the name and type of each named field. | `required` | ```bool``` | Boolean showing whether or not this field is required. | | | `group` | ```str, none_type``` | The name of the group this field is in. If this field is not a group, this defaults to `null`. | | - [[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/sdks/python/docs/TemplateResponseDocumentCustomFieldCheckbox.md b/sdks/python/docs/TemplateResponseDocumentCustomFieldCheckbox.md index b0f7e6085..62a96ed0e 100644 --- a/sdks/python/docs/TemplateResponseDocumentCustomFieldCheckbox.md +++ b/sdks/python/docs/TemplateResponseDocumentCustomFieldCheckbox.md @@ -3,12 +3,10 @@ This class extends `TemplateResponseDocumentCustomFieldBase` ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```str``` | The type of this Custom Field. Only `text` and `checkbox` are currently supported.

* Text uses `TemplateResponseDocumentCustomFieldText`
* Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox` | [default to "checkbox"] | - [[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/sdks/python/docs/TemplateResponseDocumentCustomFieldText.md b/sdks/python/docs/TemplateResponseDocumentCustomFieldText.md index a2197392f..f0c2fd527 100644 --- a/sdks/python/docs/TemplateResponseDocumentCustomFieldText.md +++ b/sdks/python/docs/TemplateResponseDocumentCustomFieldText.md @@ -3,16 +3,14 @@ This class extends `TemplateResponseDocumentCustomFieldBase` ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```str``` | The type of this Custom Field. Only `text` and `checkbox` are currently supported.

* Text uses `TemplateResponseDocumentCustomFieldText`
* Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox` | [default to "text"] | | `avg_text_length` | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | | `is_multiline` | ```bool``` | Whether this form field is multiline text. | | | `original_font_size` | ```int``` | Original font size used in this form field's text. | | | `font_family` | ```str``` | Font family used in this form field's text. | | - [[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/sdks/python/docs/TemplateResponseDocumentFieldGroup.md b/sdks/python/docs/TemplateResponseDocumentFieldGroup.md index f35b44591..ec90f2362 100644 --- a/sdks/python/docs/TemplateResponseDocumentFieldGroup.md +++ b/sdks/python/docs/TemplateResponseDocumentFieldGroup.md @@ -3,13 +3,11 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `name` | ```str``` | The name of the form field group. | | | `rule` | [```TemplateResponseDocumentFieldGroupRule```](TemplateResponseDocumentFieldGroupRule.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/sdks/python/docs/TemplateResponseDocumentFieldGroupRule.md b/sdks/python/docs/TemplateResponseDocumentFieldGroupRule.md index 06a8393b3..c23407f0e 100644 --- a/sdks/python/docs/TemplateResponseDocumentFieldGroupRule.md +++ b/sdks/python/docs/TemplateResponseDocumentFieldGroupRule.md @@ -3,13 +3,11 @@ The rule used to validate checkboxes in the form field group. See [checkbox field grouping](/api/reference/constants/#checkbox-field-grouping). ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `requirement` | ```str``` | Examples: `require_0-1` `require_1` `require_1-ormore`

- Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). - Radio groups require **at least** two fields per group. | | | `group_label` | ```str``` | Name of the group | | - [[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/sdks/python/docs/TemplateResponseDocumentFormFieldBase.md b/sdks/python/docs/TemplateResponseDocumentFormFieldBase.md index bb4b91a4b..322b09baa 100644 --- a/sdks/python/docs/TemplateResponseDocumentFormFieldBase.md +++ b/sdks/python/docs/TemplateResponseDocumentFormFieldBase.md @@ -3,9 +3,8 @@ An array of Form Field objects containing the name and type of each named field. ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```str``` | | | | `api_id` | ```str``` | A unique id for the form field. | | | `name` | ```str``` | The name of the form field. | | @@ -17,7 +16,6 @@ An array of Form Field objects containing the name and type of each named field. | `required` | ```bool``` | Boolean showing whether or not this field is required. | | | `group` | ```str, none_type``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | - [[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/sdks/python/docs/TemplateResponseDocumentFormFieldCheckbox.md b/sdks/python/docs/TemplateResponseDocumentFormFieldCheckbox.md index 6aad7acdc..fc45bdcff 100644 --- a/sdks/python/docs/TemplateResponseDocumentFormFieldCheckbox.md +++ b/sdks/python/docs/TemplateResponseDocumentFormFieldCheckbox.md @@ -3,12 +3,10 @@ This class extends `TemplateResponseDocumentFormFieldBase` ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```str``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to "checkbox"] | - [[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/sdks/python/docs/TemplateResponseDocumentFormFieldDateSigned.md b/sdks/python/docs/TemplateResponseDocumentFormFieldDateSigned.md index a07b7f327..b40da9445 100644 --- a/sdks/python/docs/TemplateResponseDocumentFormFieldDateSigned.md +++ b/sdks/python/docs/TemplateResponseDocumentFormFieldDateSigned.md @@ -3,12 +3,10 @@ This class extends `TemplateResponseDocumentFormFieldBase` ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```str``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to "date_signed"] | - [[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/sdks/python/docs/TemplateResponseDocumentFormFieldDropdown.md b/sdks/python/docs/TemplateResponseDocumentFormFieldDropdown.md index 155e1e322..83b3db08d 100644 --- a/sdks/python/docs/TemplateResponseDocumentFormFieldDropdown.md +++ b/sdks/python/docs/TemplateResponseDocumentFormFieldDropdown.md @@ -3,12 +3,10 @@ This class extends `TemplateResponseDocumentFormFieldBase` ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```str``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to "dropdown"] | - [[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/sdks/python/docs/TemplateResponseDocumentFormFieldHyperlink.md b/sdks/python/docs/TemplateResponseDocumentFormFieldHyperlink.md index b1e73fa7d..b79b5bb85 100644 --- a/sdks/python/docs/TemplateResponseDocumentFormFieldHyperlink.md +++ b/sdks/python/docs/TemplateResponseDocumentFormFieldHyperlink.md @@ -3,16 +3,14 @@ This class extends `TemplateResponseDocumentFormFieldBase` ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```str``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to "hyperlink"] | | `avg_text_length` | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | | `is_multiline` | ```bool``` | Whether this form field is multiline text. | | | `original_font_size` | ```int``` | Original font size used in this form field's text. | | | `font_family` | ```str``` | Font family used in this form field's text. | | - [[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/sdks/python/docs/TemplateResponseDocumentFormFieldInitials.md b/sdks/python/docs/TemplateResponseDocumentFormFieldInitials.md index 86c5942fe..7656afe98 100644 --- a/sdks/python/docs/TemplateResponseDocumentFormFieldInitials.md +++ b/sdks/python/docs/TemplateResponseDocumentFormFieldInitials.md @@ -3,12 +3,10 @@ This class extends `TemplateResponseDocumentFormFieldBase` ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```str``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to "initials"] | - [[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/sdks/python/docs/TemplateResponseDocumentFormFieldRadio.md b/sdks/python/docs/TemplateResponseDocumentFormFieldRadio.md index 5a69222e7..420e96f23 100644 --- a/sdks/python/docs/TemplateResponseDocumentFormFieldRadio.md +++ b/sdks/python/docs/TemplateResponseDocumentFormFieldRadio.md @@ -3,12 +3,10 @@ This class extends `TemplateResponseDocumentFormFieldBase` ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```str``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to "radio"] | - [[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/sdks/python/docs/TemplateResponseDocumentFormFieldSignature.md b/sdks/python/docs/TemplateResponseDocumentFormFieldSignature.md index 6b33dd7c7..a8dfab4bb 100644 --- a/sdks/python/docs/TemplateResponseDocumentFormFieldSignature.md +++ b/sdks/python/docs/TemplateResponseDocumentFormFieldSignature.md @@ -3,12 +3,10 @@ This class extends `TemplateResponseDocumentFormFieldBase` ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```str``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to "signature"] | - [[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/sdks/python/docs/TemplateResponseDocumentFormFieldText.md b/sdks/python/docs/TemplateResponseDocumentFormFieldText.md index b4214e34e..5728c3fc2 100644 --- a/sdks/python/docs/TemplateResponseDocumentFormFieldText.md +++ b/sdks/python/docs/TemplateResponseDocumentFormFieldText.md @@ -3,9 +3,8 @@ This class extends `TemplateResponseDocumentFormFieldBase` ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```str``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to "text"] | | `avg_text_length` | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | | `is_multiline` | ```bool``` | Whether this form field is multiline text. | | @@ -13,7 +12,6 @@ This class extends `TemplateResponseDocumentFormFieldBase` | `font_family` | ```str``` | Font family used in this form field's text. | | | `validation_type` | ```str, none_type``` | Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values. | | - [[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/sdks/python/docs/TemplateResponseDocumentStaticFieldBase.md b/sdks/python/docs/TemplateResponseDocumentStaticFieldBase.md index 1b4ad5311..8240142ff 100644 --- a/sdks/python/docs/TemplateResponseDocumentStaticFieldBase.md +++ b/sdks/python/docs/TemplateResponseDocumentStaticFieldBase.md @@ -3,9 +3,8 @@ An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```str``` | | | | `api_id` | ```str``` | A unique id for the static field. | | | `name` | ```str``` | The name of the static field. | | @@ -17,7 +16,6 @@ An array describing static overlay fields. **NOTE:** Only available for certain | `required` | ```bool``` | Boolean showing whether or not this field is required. | | | `group` | ```str, none_type``` | The name of the group this field is in. If this field is not a group, this defaults to `null`. | | - [[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/sdks/python/docs/TemplateResponseDocumentStaticFieldCheckbox.md b/sdks/python/docs/TemplateResponseDocumentStaticFieldCheckbox.md index aed2054db..628884a7b 100644 --- a/sdks/python/docs/TemplateResponseDocumentStaticFieldCheckbox.md +++ b/sdks/python/docs/TemplateResponseDocumentStaticFieldCheckbox.md @@ -3,12 +3,10 @@ This class extends `TemplateResponseDocumentStaticFieldBase` ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```str``` | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to "checkbox"] | - [[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/sdks/python/docs/TemplateResponseDocumentStaticFieldDateSigned.md b/sdks/python/docs/TemplateResponseDocumentStaticFieldDateSigned.md index 8eeaa39b7..3124121ed 100644 --- a/sdks/python/docs/TemplateResponseDocumentStaticFieldDateSigned.md +++ b/sdks/python/docs/TemplateResponseDocumentStaticFieldDateSigned.md @@ -3,12 +3,10 @@ This class extends `TemplateResponseDocumentStaticFieldBase` ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```str``` | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to "date_signed"] | - [[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/sdks/python/docs/TemplateResponseDocumentStaticFieldDropdown.md b/sdks/python/docs/TemplateResponseDocumentStaticFieldDropdown.md index d3fac7957..1b0424a2a 100644 --- a/sdks/python/docs/TemplateResponseDocumentStaticFieldDropdown.md +++ b/sdks/python/docs/TemplateResponseDocumentStaticFieldDropdown.md @@ -3,12 +3,10 @@ This class extends `TemplateResponseDocumentStaticFieldBase` ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```str``` | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to "dropdown"] | - [[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/sdks/python/docs/TemplateResponseDocumentStaticFieldHyperlink.md b/sdks/python/docs/TemplateResponseDocumentStaticFieldHyperlink.md index c7c08bfea..3b9a20dbf 100644 --- a/sdks/python/docs/TemplateResponseDocumentStaticFieldHyperlink.md +++ b/sdks/python/docs/TemplateResponseDocumentStaticFieldHyperlink.md @@ -3,12 +3,10 @@ This class extends `TemplateResponseDocumentStaticFieldBase` ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```str``` | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to "hyperlink"] | - [[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/sdks/python/docs/TemplateResponseDocumentStaticFieldInitials.md b/sdks/python/docs/TemplateResponseDocumentStaticFieldInitials.md index f60380d6f..3162cdb13 100644 --- a/sdks/python/docs/TemplateResponseDocumentStaticFieldInitials.md +++ b/sdks/python/docs/TemplateResponseDocumentStaticFieldInitials.md @@ -3,12 +3,10 @@ This class extends `TemplateResponseDocumentStaticFieldBase` ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```str``` | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to "initials"] | - [[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/sdks/python/docs/TemplateResponseDocumentStaticFieldRadio.md b/sdks/python/docs/TemplateResponseDocumentStaticFieldRadio.md index 1274162b8..12f3fc31b 100644 --- a/sdks/python/docs/TemplateResponseDocumentStaticFieldRadio.md +++ b/sdks/python/docs/TemplateResponseDocumentStaticFieldRadio.md @@ -3,12 +3,10 @@ This class extends `TemplateResponseDocumentStaticFieldBase` ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```str``` | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to "radio"] | - [[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/sdks/python/docs/TemplateResponseDocumentStaticFieldSignature.md b/sdks/python/docs/TemplateResponseDocumentStaticFieldSignature.md index a9496a99e..453588a62 100644 --- a/sdks/python/docs/TemplateResponseDocumentStaticFieldSignature.md +++ b/sdks/python/docs/TemplateResponseDocumentStaticFieldSignature.md @@ -3,12 +3,10 @@ This class extends `TemplateResponseDocumentStaticFieldBase` ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```str``` | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to "signature"] | - [[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/sdks/python/docs/TemplateResponseDocumentStaticFieldText.md b/sdks/python/docs/TemplateResponseDocumentStaticFieldText.md index 89c3cffb0..d468ca4a5 100644 --- a/sdks/python/docs/TemplateResponseDocumentStaticFieldText.md +++ b/sdks/python/docs/TemplateResponseDocumentStaticFieldText.md @@ -3,12 +3,10 @@ This class extends `TemplateResponseDocumentStaticFieldBase` ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```str``` | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to "text"] | - [[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/sdks/python/docs/TemplateResponseFieldAvgTextLength.md b/sdks/python/docs/TemplateResponseFieldAvgTextLength.md index 07c94cbb2..231267889 100644 --- a/sdks/python/docs/TemplateResponseFieldAvgTextLength.md +++ b/sdks/python/docs/TemplateResponseFieldAvgTextLength.md @@ -3,13 +3,11 @@ Average text length in this field. ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `num_lines` | ```int``` | Number of lines. | | | `num_chars_per_line` | ```int``` | Number of characters per line. | | - [[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/sdks/python/docs/TemplateResponseSignerRole.md b/sdks/python/docs/TemplateResponseSignerRole.md index f4e0d4537..060870d39 100644 --- a/sdks/python/docs/TemplateResponseSignerRole.md +++ b/sdks/python/docs/TemplateResponseSignerRole.md @@ -3,13 +3,11 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `name` | ```str``` | The name of the Role. | | | `order` | ```int``` | If signer order is assigned this is the 0-based index for this role. | | - [[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/sdks/python/docs/TemplateUpdateFilesRequest.md b/sdks/python/docs/TemplateUpdateFilesRequest.md index f3a429f57..e853b1601 100644 --- a/sdks/python/docs/TemplateUpdateFilesRequest.md +++ b/sdks/python/docs/TemplateUpdateFilesRequest.md @@ -3,9 +3,8 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `client_id` | ```str``` | Client id of the app you're using to update this template. | | | `files` | ```[file_type]``` | Use `files[]` to indicate the uploaded file(s) to use for the template.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `file_urls` | ```[str]``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to use for the template.

This endpoint requires either **files** or **file_urls[]**, but not both. | | @@ -13,7 +12,6 @@ | `subject` | ```str``` | The new default template email subject. | | | `test_mode` | ```bool``` | Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. | [default to False] | - [[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/sdks/python/docs/TemplateUpdateFilesResponse.md b/sdks/python/docs/TemplateUpdateFilesResponse.md index 254d949af..1f62b457f 100644 --- a/sdks/python/docs/TemplateUpdateFilesResponse.md +++ b/sdks/python/docs/TemplateUpdateFilesResponse.md @@ -3,12 +3,10 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `template` | [```TemplateUpdateFilesResponseTemplate```](TemplateUpdateFilesResponseTemplate.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/sdks/python/docs/TemplateUpdateFilesResponseTemplate.md b/sdks/python/docs/TemplateUpdateFilesResponseTemplate.md index 3dbc3392d..4efece562 100644 --- a/sdks/python/docs/TemplateUpdateFilesResponseTemplate.md +++ b/sdks/python/docs/TemplateUpdateFilesResponseTemplate.md @@ -3,13 +3,11 @@ Contains template id ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `template_id` | ```str``` | The id of the Template. | | | `warnings` | [```[WarningResponse]```](WarningResponse.md) | A list of warnings. | | - [[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/sdks/python/docs/UnclaimedDraftApi.md b/sdks/python/docs/UnclaimedDraftApi.md index 3aa6a49bf..7bb1bf93b 100644 --- a/sdks/python/docs/UnclaimedDraftApi.md +++ b/sdks/python/docs/UnclaimedDraftApi.md @@ -2,8 +2,8 @@ All URIs are relative to *https://api.hellosign.com/v3* -|Method | HTTP request | Description| -|------------- | ------------- | -------------| +Method | HTTP request | Description +------------- | ------------- | ------------- |[```unclaimed_draft_create```](UnclaimedDraftApi.md#unclaimed_draft_create) | ```POST /unclaimed_draft/create``` | Create Unclaimed Draft| |[```unclaimed_draft_create_embedded```](UnclaimedDraftApi.md#unclaimed_draft_create_embedded) | ```POST /unclaimed_draft/create_embedded``` | Create Embedded Unclaimed Draft| |[```unclaimed_draft_create_embedded_with_template```](UnclaimedDraftApi.md#unclaimed_draft_create_embedded_with_template) | ```POST /unclaimed_draft/create_embedded_with_template``` | Create Embedded Unclaimed Draft with Template| @@ -92,7 +92,6 @@ with ApiClient(configuration) as api_client: ### Parameters - | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `unclaimed_draft_create_request` | [**UnclaimedDraftCreateRequest**](UnclaimedDraftCreateRequest.md) | | | @@ -166,7 +165,6 @@ with ApiClient(configuration) as api_client: ### Parameters - | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `unclaimed_draft_create_embedded_request` | [**UnclaimedDraftCreateEmbeddedRequest**](UnclaimedDraftCreateEmbeddedRequest.md) | | | @@ -253,7 +251,6 @@ with ApiClient(configuration) as api_client: ### Parameters - | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `unclaimed_draft_create_embedded_with_template_request` | [**UnclaimedDraftCreateEmbeddedWithTemplateRequest**](UnclaimedDraftCreateEmbeddedWithTemplateRequest.md) | | | @@ -327,7 +324,6 @@ with ApiClient(configuration) as api_client: ### Parameters - | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `signature_request_id` | **str** | The ID of the signature request to edit and resend. | | diff --git a/sdks/python/docs/UnclaimedDraftCreateEmbeddedRequest.md b/sdks/python/docs/UnclaimedDraftCreateEmbeddedRequest.md index 94e5e0451..8a2f2da2e 100644 --- a/sdks/python/docs/UnclaimedDraftCreateEmbeddedRequest.md +++ b/sdks/python/docs/UnclaimedDraftCreateEmbeddedRequest.md @@ -3,9 +3,8 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `client_id`*_required_ | ```str``` | Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app. | | | `requester_email_address`*_required_ | ```str``` | The email address of the user that should be designated as the requester of this draft, if the draft type is `request_signature`. | | | `files` | ```[file_type]``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | @@ -43,7 +42,6 @@ | `populate_auto_fill_fields` | ```bool``` | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.

**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [default to False] | | `expires_at` | ```int, none_type``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.

**NOTE:** This does not correspond to the **expires_at** returned in the response. | | - [[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/sdks/python/docs/UnclaimedDraftCreateEmbeddedWithTemplateRequest.md b/sdks/python/docs/UnclaimedDraftCreateEmbeddedWithTemplateRequest.md index d5a2806a4..2bdd6fb35 100644 --- a/sdks/python/docs/UnclaimedDraftCreateEmbeddedWithTemplateRequest.md +++ b/sdks/python/docs/UnclaimedDraftCreateEmbeddedWithTemplateRequest.md @@ -3,9 +3,8 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `client_id`*_required_ | ```str``` | Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app. | | | `requester_email_address`*_required_ | ```str``` | The email address of the user that should be designated as the requester of this draft. | | | `template_ids`*_required_ | ```[str]``` | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the templates will be used. | | @@ -37,7 +36,6 @@ | `populate_auto_fill_fields` | ```bool``` | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.

**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [default to False] | | `allow_ccs` | ```bool``` | This allows the requester to specify whether the user is allowed to provide email addresses to CC when claiming the draft. | [default to False] | - [[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/sdks/python/docs/UnclaimedDraftCreateRequest.md b/sdks/python/docs/UnclaimedDraftCreateRequest.md index 78379a276..b2b478f92 100644 --- a/sdks/python/docs/UnclaimedDraftCreateRequest.md +++ b/sdks/python/docs/UnclaimedDraftCreateRequest.md @@ -3,9 +3,8 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```str``` | The type of unclaimed draft to create. Use `send_document` to create a claimable file, and `request_signature` for a claimable signature request. If the type is `request_signature` then signers name and email_address are not optional. | | | `files` | ```[file_type]``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `file_urls` | ```[str]``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | @@ -31,7 +30,6 @@ | `use_text_tags` | ```bool``` | Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. | [default to False] | | `expires_at` | ```int, none_type``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.

**NOTE:** This does not correspond to the **expires_at** returned in the response. | | - [[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/sdks/python/docs/UnclaimedDraftCreateResponse.md b/sdks/python/docs/UnclaimedDraftCreateResponse.md index 98222ba9c..f68452899 100644 --- a/sdks/python/docs/UnclaimedDraftCreateResponse.md +++ b/sdks/python/docs/UnclaimedDraftCreateResponse.md @@ -3,13 +3,11 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `unclaimed_draft` | [```UnclaimedDraftResponse```](UnclaimedDraftResponse.md) | | | | `warnings` | [```[WarningResponse]```](WarningResponse.md) | A list of warnings. | | - [[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/sdks/python/docs/UnclaimedDraftEditAndResendRequest.md b/sdks/python/docs/UnclaimedDraftEditAndResendRequest.md index 6c76b3f0c..4782fa45a 100644 --- a/sdks/python/docs/UnclaimedDraftEditAndResendRequest.md +++ b/sdks/python/docs/UnclaimedDraftEditAndResendRequest.md @@ -3,9 +3,8 @@ ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `client_id`*_required_ | ```str``` | Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app. | | | `editor_options` | [```SubEditorOptions```](SubEditorOptions.md) | | | | `is_for_embedded_signing` | ```bool``` | The request created from this draft will also be signable in embedded mode if set to `true`. | | @@ -15,7 +14,6 @@ | `signing_redirect_url` | ```str``` | The URL you want signers redirected to after they successfully sign. | | | `test_mode` | ```bool``` | Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. | [default to False] | - [[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/sdks/python/docs/UnclaimedDraftResponse.md b/sdks/python/docs/UnclaimedDraftResponse.md index 8865726c5..5daa01a10 100644 --- a/sdks/python/docs/UnclaimedDraftResponse.md +++ b/sdks/python/docs/UnclaimedDraftResponse.md @@ -3,9 +3,8 @@ A group of documents that a user can take ownership of via the claim URL. ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `signature_request_id` | ```str, none_type``` | The ID of the signature request that is represented by this UnclaimedDraft. | | | `claim_url` | ```str``` | The URL to be used to claim this UnclaimedDraft. | | | `signing_redirect_url` | ```str, none_type``` | The URL you want signers redirected to after they successfully sign. | | @@ -13,7 +12,6 @@ A group of documents that a user can take ownership of via the claim URL. | `expires_at` | ```int, none_type``` | When the link expires. | | | `test_mode` | ```bool``` | Whether this is a test draft. Signature requests made from test drafts have no legal value. | | - [[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/sdks/python/docs/WarningResponse.md b/sdks/python/docs/WarningResponse.md index 33a233dc2..c015bda8b 100644 --- a/sdks/python/docs/WarningResponse.md +++ b/sdks/python/docs/WarningResponse.md @@ -3,13 +3,11 @@ A list of warnings. ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- | `warning_msg`*_required_ | ```str``` | Warning message | | | `warning_name`*_required_ | ```str``` | Warning name | | - [[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/sdks/python/dropbox_sign/model/account_create_request.py b/sdks/python/dropbox_sign/model/account_create_request.py index f0cedb207..2271c35e1 100644 --- a/sdks/python/dropbox_sign/model/account_create_request.py +++ b/sdks/python/dropbox_sign/model/account_create_request.py @@ -14,7 +14,6 @@ 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, @@ -112,6 +111,7 @@ def init(data: any) -> AccountCreateRequest: _check_type=True, ) + attribute_map = { 'email_address': 'email_address', # noqa: E501 'client_id': 'client_id', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/account_create_response.py b/sdks/python/dropbox_sign/model/account_create_response.py index f65c75707..bea340d7a 100644 --- a/sdks/python/dropbox_sign/model/account_create_response.py +++ b/sdks/python/dropbox_sign/model/account_create_response.py @@ -14,7 +14,6 @@ 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, @@ -125,6 +124,7 @@ def init(data: any) -> AccountCreateResponse: _check_type=True, ) + attribute_map = { 'account': 'account', # noqa: E501 'oauth_data': 'oauth_data', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/account_get_response.py b/sdks/python/dropbox_sign/model/account_get_response.py index 93d494ecc..c90fa3a77 100644 --- a/sdks/python/dropbox_sign/model/account_get_response.py +++ b/sdks/python/dropbox_sign/model/account_get_response.py @@ -14,7 +14,6 @@ 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, @@ -121,6 +120,7 @@ def init(data: any) -> AccountGetResponse: _check_type=True, ) + attribute_map = { 'account': 'account', # noqa: E501 'warnings': 'warnings', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/account_response.py b/sdks/python/dropbox_sign/model/account_response.py index 3c35e6342..54263a9dc 100644 --- a/sdks/python/dropbox_sign/model/account_response.py +++ b/sdks/python/dropbox_sign/model/account_response.py @@ -14,7 +14,6 @@ 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, @@ -130,6 +129,7 @@ def init(data: any) -> AccountResponse: _check_type=True, ) + attribute_map = { 'account_id': 'account_id', # noqa: E501 'email_address': 'email_address', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/account_response_quotas.py b/sdks/python/dropbox_sign/model/account_response_quotas.py index a38ffcc40..1e588f3f4 100644 --- a/sdks/python/dropbox_sign/model/account_response_quotas.py +++ b/sdks/python/dropbox_sign/model/account_response_quotas.py @@ -14,7 +14,6 @@ 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, @@ -114,6 +113,7 @@ def init(data: any) -> AccountResponseQuotas: _check_type=True, ) + attribute_map = { 'api_signature_requests_left': 'api_signature_requests_left', # noqa: E501 'documents_left': 'documents_left', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/account_response_usage.py b/sdks/python/dropbox_sign/model/account_response_usage.py index 8bdf363ee..c1c6bfa52 100644 --- a/sdks/python/dropbox_sign/model/account_response_usage.py +++ b/sdks/python/dropbox_sign/model/account_response_usage.py @@ -14,7 +14,6 @@ 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, @@ -109,6 +108,7 @@ def init(data: any) -> AccountResponseUsage: _check_type=True, ) + attribute_map = { 'fax_pages_sent': 'fax_pages_sent', # noqa: E501 } diff --git a/sdks/python/dropbox_sign/model/account_update_request.py b/sdks/python/dropbox_sign/model/account_update_request.py index 3f7530df6..3693e56b6 100644 --- a/sdks/python/dropbox_sign/model/account_update_request.py +++ b/sdks/python/dropbox_sign/model/account_update_request.py @@ -14,7 +14,6 @@ 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, @@ -111,6 +110,7 @@ def init(data: any) -> AccountUpdateRequest: _check_type=True, ) + attribute_map = { 'account_id': 'account_id', # noqa: E501 'callback_url': 'callback_url', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/account_verify_request.py b/sdks/python/dropbox_sign/model/account_verify_request.py index 51b7dc967..1d9096149 100644 --- a/sdks/python/dropbox_sign/model/account_verify_request.py +++ b/sdks/python/dropbox_sign/model/account_verify_request.py @@ -14,7 +14,6 @@ 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, @@ -109,6 +108,7 @@ def init(data: any) -> AccountVerifyRequest: _check_type=True, ) + attribute_map = { 'email_address': 'email_address', # noqa: E501 } diff --git a/sdks/python/dropbox_sign/model/account_verify_response.py b/sdks/python/dropbox_sign/model/account_verify_response.py index 759ccafaf..520d4f728 100644 --- a/sdks/python/dropbox_sign/model/account_verify_response.py +++ b/sdks/python/dropbox_sign/model/account_verify_response.py @@ -14,7 +14,6 @@ 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, @@ -121,6 +120,7 @@ def init(data: any) -> AccountVerifyResponse: _check_type=True, ) + attribute_map = { 'account': 'account', # noqa: E501 'warnings': 'warnings', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/account_verify_response_account.py b/sdks/python/dropbox_sign/model/account_verify_response_account.py index ab275f434..64d9e5a78 100644 --- a/sdks/python/dropbox_sign/model/account_verify_response_account.py +++ b/sdks/python/dropbox_sign/model/account_verify_response_account.py @@ -14,7 +14,6 @@ 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, @@ -109,6 +108,7 @@ def init(data: any) -> AccountVerifyResponseAccount: _check_type=True, ) + attribute_map = { 'email_address': 'email_address', # noqa: E501 } diff --git a/sdks/python/dropbox_sign/model/api_app_create_request.py b/sdks/python/dropbox_sign/model/api_app_create_request.py index e9f887a74..dcd165b39 100644 --- a/sdks/python/dropbox_sign/model/api_app_create_request.py +++ b/sdks/python/dropbox_sign/model/api_app_create_request.py @@ -14,7 +14,6 @@ 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, @@ -133,6 +132,7 @@ def init(data: any) -> ApiAppCreateRequest: _check_type=True, ) + attribute_map = { 'domains': 'domains', # noqa: E501 'name': 'name', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/api_app_get_response.py b/sdks/python/dropbox_sign/model/api_app_get_response.py index 306458f99..3ab6bd00a 100644 --- a/sdks/python/dropbox_sign/model/api_app_get_response.py +++ b/sdks/python/dropbox_sign/model/api_app_get_response.py @@ -14,7 +14,6 @@ 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, @@ -121,6 +120,7 @@ def init(data: any) -> ApiAppGetResponse: _check_type=True, ) + attribute_map = { 'api_app': 'api_app', # noqa: E501 'warnings': 'warnings', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/api_app_list_response.py b/sdks/python/dropbox_sign/model/api_app_list_response.py index e3d49ab69..62bd5a75c 100644 --- a/sdks/python/dropbox_sign/model/api_app_list_response.py +++ b/sdks/python/dropbox_sign/model/api_app_list_response.py @@ -14,7 +14,6 @@ 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, @@ -125,6 +124,7 @@ def init(data: any) -> ApiAppListResponse: _check_type=True, ) + attribute_map = { 'api_apps': 'api_apps', # noqa: E501 'list_info': 'list_info', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/api_app_response.py b/sdks/python/dropbox_sign/model/api_app_response.py index e9b610da3..7d5852732 100644 --- a/sdks/python/dropbox_sign/model/api_app_response.py +++ b/sdks/python/dropbox_sign/model/api_app_response.py @@ -14,7 +14,6 @@ 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, @@ -135,6 +134,7 @@ def init(data: any) -> ApiAppResponse: _check_type=True, ) + attribute_map = { 'callback_url': 'callback_url', # noqa: E501 'client_id': 'client_id', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/api_app_response_o_auth.py b/sdks/python/dropbox_sign/model/api_app_response_o_auth.py index 9453dcbb8..26d525b28 100644 --- a/sdks/python/dropbox_sign/model/api_app_response_o_auth.py +++ b/sdks/python/dropbox_sign/model/api_app_response_o_auth.py @@ -14,7 +14,6 @@ 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, @@ -112,6 +111,7 @@ def init(data: any) -> ApiAppResponseOAuth: _check_type=True, ) + attribute_map = { 'callback_url': 'callback_url', # noqa: E501 'secret': 'secret', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/api_app_response_options.py b/sdks/python/dropbox_sign/model/api_app_response_options.py index ab439045d..0a81a6b95 100644 --- a/sdks/python/dropbox_sign/model/api_app_response_options.py +++ b/sdks/python/dropbox_sign/model/api_app_response_options.py @@ -14,7 +14,6 @@ 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, @@ -109,6 +108,7 @@ def init(data: any) -> ApiAppResponseOptions: _check_type=True, ) + attribute_map = { 'can_insert_everywhere': 'can_insert_everywhere', # noqa: E501 } diff --git a/sdks/python/dropbox_sign/model/api_app_response_owner_account.py b/sdks/python/dropbox_sign/model/api_app_response_owner_account.py index 519ec0cf9..765381b57 100644 --- a/sdks/python/dropbox_sign/model/api_app_response_owner_account.py +++ b/sdks/python/dropbox_sign/model/api_app_response_owner_account.py @@ -14,7 +14,6 @@ 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, @@ -110,6 +109,7 @@ def init(data: any) -> ApiAppResponseOwnerAccount: _check_type=True, ) + attribute_map = { 'account_id': 'account_id', # noqa: E501 'email_address': 'email_address', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/api_app_response_white_labeling_options.py b/sdks/python/dropbox_sign/model/api_app_response_white_labeling_options.py index 61a6f1b55..0319f9e43 100644 --- a/sdks/python/dropbox_sign/model/api_app_response_white_labeling_options.py +++ b/sdks/python/dropbox_sign/model/api_app_response_white_labeling_options.py @@ -14,7 +14,6 @@ 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, @@ -122,6 +121,7 @@ def init(data: any) -> ApiAppResponseWhiteLabelingOptions: _check_type=True, ) + attribute_map = { 'header_background_color': 'header_background_color', # noqa: E501 'legal_version': 'legal_version', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/api_app_update_request.py b/sdks/python/dropbox_sign/model/api_app_update_request.py index 87885b375..656c0edc6 100644 --- a/sdks/python/dropbox_sign/model/api_app_update_request.py +++ b/sdks/python/dropbox_sign/model/api_app_update_request.py @@ -14,7 +14,6 @@ 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, @@ -132,6 +131,7 @@ def init(data: any) -> ApiAppUpdateRequest: _check_type=True, ) + attribute_map = { 'callback_url': 'callback_url', # noqa: E501 'custom_logo_file': 'custom_logo_file', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/bulk_send_job_get_response.py b/sdks/python/dropbox_sign/model/bulk_send_job_get_response.py index 3fce46bf5..89f1559be 100644 --- a/sdks/python/dropbox_sign/model/bulk_send_job_get_response.py +++ b/sdks/python/dropbox_sign/model/bulk_send_job_get_response.py @@ -14,7 +14,6 @@ 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, @@ -129,6 +128,7 @@ def init(data: any) -> BulkSendJobGetResponse: _check_type=True, ) + attribute_map = { 'bulk_send_job': 'bulk_send_job', # noqa: E501 'list_info': 'list_info', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/bulk_send_job_get_response_signature_requests.py b/sdks/python/dropbox_sign/model/bulk_send_job_get_response_signature_requests.py index b9963bbc6..aa0b75c0b 100644 --- a/sdks/python/dropbox_sign/model/bulk_send_job_get_response_signature_requests.py +++ b/sdks/python/dropbox_sign/model/bulk_send_job_get_response_signature_requests.py @@ -14,7 +14,6 @@ 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, diff --git a/sdks/python/dropbox_sign/model/bulk_send_job_list_response.py b/sdks/python/dropbox_sign/model/bulk_send_job_list_response.py index b2b54d58a..bbd7975b7 100644 --- a/sdks/python/dropbox_sign/model/bulk_send_job_list_response.py +++ b/sdks/python/dropbox_sign/model/bulk_send_job_list_response.py @@ -14,7 +14,6 @@ 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, @@ -125,6 +124,7 @@ def init(data: any) -> BulkSendJobListResponse: _check_type=True, ) + attribute_map = { 'bulk_send_jobs': 'bulk_send_jobs', # noqa: E501 'list_info': 'list_info', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/bulk_send_job_response.py b/sdks/python/dropbox_sign/model/bulk_send_job_response.py index a2f7066c1..34788ce5f 100644 --- a/sdks/python/dropbox_sign/model/bulk_send_job_response.py +++ b/sdks/python/dropbox_sign/model/bulk_send_job_response.py @@ -14,7 +14,6 @@ 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, @@ -112,6 +111,7 @@ def init(data: any) -> BulkSendJobResponse: _check_type=True, ) + attribute_map = { 'bulk_send_job_id': 'bulk_send_job_id', # noqa: E501 'total': 'total', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/bulk_send_job_send_response.py b/sdks/python/dropbox_sign/model/bulk_send_job_send_response.py index c605e04ef..d08752a14 100644 --- a/sdks/python/dropbox_sign/model/bulk_send_job_send_response.py +++ b/sdks/python/dropbox_sign/model/bulk_send_job_send_response.py @@ -14,7 +14,6 @@ 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, @@ -121,6 +120,7 @@ def init(data: any) -> BulkSendJobSendResponse: _check_type=True, ) + attribute_map = { 'bulk_send_job': 'bulk_send_job', # noqa: E501 'warnings': 'warnings', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/embedded_edit_url_request.py b/sdks/python/dropbox_sign/model/embedded_edit_url_request.py index b1544ed08..a265c6a60 100644 --- a/sdks/python/dropbox_sign/model/embedded_edit_url_request.py +++ b/sdks/python/dropbox_sign/model/embedded_edit_url_request.py @@ -14,7 +14,6 @@ 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, @@ -129,6 +128,7 @@ def init(data: any) -> EmbeddedEditUrlRequest: _check_type=True, ) + attribute_map = { 'allow_edit_ccs': 'allow_edit_ccs', # noqa: E501 'cc_roles': 'cc_roles', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/embedded_edit_url_response.py b/sdks/python/dropbox_sign/model/embedded_edit_url_response.py index 963f7a365..c8b0e9b65 100644 --- a/sdks/python/dropbox_sign/model/embedded_edit_url_response.py +++ b/sdks/python/dropbox_sign/model/embedded_edit_url_response.py @@ -14,7 +14,6 @@ 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, @@ -121,6 +120,7 @@ def init(data: any) -> EmbeddedEditUrlResponse: _check_type=True, ) + attribute_map = { 'embedded': 'embedded', # noqa: E501 'warnings': 'warnings', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/embedded_edit_url_response_embedded.py b/sdks/python/dropbox_sign/model/embedded_edit_url_response_embedded.py index c2cf26745..427e0310f 100644 --- a/sdks/python/dropbox_sign/model/embedded_edit_url_response_embedded.py +++ b/sdks/python/dropbox_sign/model/embedded_edit_url_response_embedded.py @@ -14,7 +14,6 @@ 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, @@ -110,6 +109,7 @@ def init(data: any) -> EmbeddedEditUrlResponseEmbedded: _check_type=True, ) + attribute_map = { 'edit_url': 'edit_url', # noqa: E501 'expires_at': 'expires_at', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/embedded_sign_url_response.py b/sdks/python/dropbox_sign/model/embedded_sign_url_response.py index 0166f9969..3b16faa4e 100644 --- a/sdks/python/dropbox_sign/model/embedded_sign_url_response.py +++ b/sdks/python/dropbox_sign/model/embedded_sign_url_response.py @@ -14,7 +14,6 @@ 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, @@ -121,6 +120,7 @@ def init(data: any) -> EmbeddedSignUrlResponse: _check_type=True, ) + attribute_map = { 'embedded': 'embedded', # noqa: E501 'warnings': 'warnings', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/embedded_sign_url_response_embedded.py b/sdks/python/dropbox_sign/model/embedded_sign_url_response_embedded.py index 22ae6918e..73640656c 100644 --- a/sdks/python/dropbox_sign/model/embedded_sign_url_response_embedded.py +++ b/sdks/python/dropbox_sign/model/embedded_sign_url_response_embedded.py @@ -14,7 +14,6 @@ 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, @@ -110,6 +109,7 @@ def init(data: any) -> EmbeddedSignUrlResponseEmbedded: _check_type=True, ) + attribute_map = { 'sign_url': 'sign_url', # noqa: E501 'expires_at': 'expires_at', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/error_response.py b/sdks/python/dropbox_sign/model/error_response.py index 981ce0c4c..3d07ad02e 100644 --- a/sdks/python/dropbox_sign/model/error_response.py +++ b/sdks/python/dropbox_sign/model/error_response.py @@ -14,7 +14,6 @@ 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, @@ -117,6 +116,7 @@ def init(data: any) -> ErrorResponse: _check_type=True, ) + attribute_map = { 'error': 'error', # noqa: E501 } diff --git a/sdks/python/dropbox_sign/model/error_response_error.py b/sdks/python/dropbox_sign/model/error_response_error.py index b71019221..db093f573 100644 --- a/sdks/python/dropbox_sign/model/error_response_error.py +++ b/sdks/python/dropbox_sign/model/error_response_error.py @@ -14,7 +14,6 @@ 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, @@ -111,6 +110,7 @@ def init(data: any) -> ErrorResponseError: _check_type=True, ) + attribute_map = { 'error_msg': 'error_msg', # noqa: E501 'error_name': 'error_name', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/event_callback_request.py b/sdks/python/dropbox_sign/model/event_callback_request.py index 24f455f60..12c1d3bdd 100644 --- a/sdks/python/dropbox_sign/model/event_callback_request.py +++ b/sdks/python/dropbox_sign/model/event_callback_request.py @@ -14,7 +14,6 @@ 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, @@ -129,6 +128,7 @@ def init(data: any) -> EventCallbackRequest: _check_type=True, ) + attribute_map = { 'event': 'event', # noqa: E501 'account': 'account', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/event_callback_request_event.py b/sdks/python/dropbox_sign/model/event_callback_request_event.py index 36fd019dc..28e625740 100644 --- a/sdks/python/dropbox_sign/model/event_callback_request_event.py +++ b/sdks/python/dropbox_sign/model/event_callback_request_event.py @@ -14,7 +14,6 @@ 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, @@ -145,6 +144,7 @@ def init(data: any) -> EventCallbackRequestEvent: _check_type=True, ) + attribute_map = { 'event_time': 'event_time', # noqa: E501 'event_type': 'event_type', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/event_callback_request_event_metadata.py b/sdks/python/dropbox_sign/model/event_callback_request_event_metadata.py index a0975c0db..619021379 100644 --- a/sdks/python/dropbox_sign/model/event_callback_request_event_metadata.py +++ b/sdks/python/dropbox_sign/model/event_callback_request_event_metadata.py @@ -14,7 +14,6 @@ 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, @@ -112,6 +111,7 @@ def init(data: any) -> EventCallbackRequestEventMetadata: _check_type=True, ) + attribute_map = { 'related_signature_id': 'related_signature_id', # noqa: E501 'reported_for_account_id': 'reported_for_account_id', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/fax_line_add_user_request.py b/sdks/python/dropbox_sign/model/fax_line_add_user_request.py index 234fdbafa..29e736156 100644 --- a/sdks/python/dropbox_sign/model/fax_line_add_user_request.py +++ b/sdks/python/dropbox_sign/model/fax_line_add_user_request.py @@ -14,7 +14,6 @@ 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, @@ -111,6 +110,7 @@ def init(data: any) -> FaxLineAddUserRequest: _check_type=True, ) + attribute_map = { 'number': 'number', # noqa: E501 'account_id': 'account_id', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/fax_line_area_code_get_country_enum.py b/sdks/python/dropbox_sign/model/fax_line_area_code_get_country_enum.py index cbd0d8ce4..c182f8140 100644 --- a/sdks/python/dropbox_sign/model/fax_line_area_code_get_country_enum.py +++ b/sdks/python/dropbox_sign/model/fax_line_area_code_get_country_enum.py @@ -14,7 +14,6 @@ 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, diff --git a/sdks/python/dropbox_sign/model/fax_line_area_code_get_province_enum.py b/sdks/python/dropbox_sign/model/fax_line_area_code_get_province_enum.py index a9e640a58..5346ab6e8 100644 --- a/sdks/python/dropbox_sign/model/fax_line_area_code_get_province_enum.py +++ b/sdks/python/dropbox_sign/model/fax_line_area_code_get_province_enum.py @@ -14,7 +14,6 @@ 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, diff --git a/sdks/python/dropbox_sign/model/fax_line_area_code_get_response.py b/sdks/python/dropbox_sign/model/fax_line_area_code_get_response.py index d856d9e2c..d5c4c6c53 100644 --- a/sdks/python/dropbox_sign/model/fax_line_area_code_get_response.py +++ b/sdks/python/dropbox_sign/model/fax_line_area_code_get_response.py @@ -14,7 +14,6 @@ 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, @@ -109,6 +108,7 @@ def init(data: any) -> FaxLineAreaCodeGetResponse: _check_type=True, ) + attribute_map = { 'area_codes': 'area_codes', # noqa: E501 } diff --git a/sdks/python/dropbox_sign/model/fax_line_area_code_get_state_enum.py b/sdks/python/dropbox_sign/model/fax_line_area_code_get_state_enum.py index e070603d3..f3d9c2454 100644 --- a/sdks/python/dropbox_sign/model/fax_line_area_code_get_state_enum.py +++ b/sdks/python/dropbox_sign/model/fax_line_area_code_get_state_enum.py @@ -14,7 +14,6 @@ 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, diff --git a/sdks/python/dropbox_sign/model/fax_line_create_request.py b/sdks/python/dropbox_sign/model/fax_line_create_request.py index 6a0789680..0d1221b75 100644 --- a/sdks/python/dropbox_sign/model/fax_line_create_request.py +++ b/sdks/python/dropbox_sign/model/fax_line_create_request.py @@ -14,7 +14,6 @@ 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, @@ -117,6 +116,7 @@ def init(data: any) -> FaxLineCreateRequest: _check_type=True, ) + attribute_map = { 'area_code': 'area_code', # noqa: E501 'country': 'country', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/fax_line_delete_request.py b/sdks/python/dropbox_sign/model/fax_line_delete_request.py index 68605d0ce..4a0aea281 100644 --- a/sdks/python/dropbox_sign/model/fax_line_delete_request.py +++ b/sdks/python/dropbox_sign/model/fax_line_delete_request.py @@ -14,7 +14,6 @@ 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, @@ -109,6 +108,7 @@ def init(data: any) -> FaxLineDeleteRequest: _check_type=True, ) + attribute_map = { 'number': 'number', # noqa: E501 } diff --git a/sdks/python/dropbox_sign/model/fax_line_list_response.py b/sdks/python/dropbox_sign/model/fax_line_list_response.py index 1bcac65d0..caa2577c0 100644 --- a/sdks/python/dropbox_sign/model/fax_line_list_response.py +++ b/sdks/python/dropbox_sign/model/fax_line_list_response.py @@ -14,7 +14,6 @@ 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, @@ -125,6 +124,7 @@ def init(data: any) -> FaxLineListResponse: _check_type=True, ) + attribute_map = { 'list_info': 'list_info', # noqa: E501 'fax_lines': 'fax_lines', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/fax_line_remove_user_request.py b/sdks/python/dropbox_sign/model/fax_line_remove_user_request.py index 7867fa69a..979157e1a 100644 --- a/sdks/python/dropbox_sign/model/fax_line_remove_user_request.py +++ b/sdks/python/dropbox_sign/model/fax_line_remove_user_request.py @@ -14,7 +14,6 @@ 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, @@ -111,6 +110,7 @@ def init(data: any) -> FaxLineRemoveUserRequest: _check_type=True, ) + attribute_map = { 'number': 'number', # noqa: E501 'account_id': 'account_id', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/fax_line_response.py b/sdks/python/dropbox_sign/model/fax_line_response.py index 7de499c2b..74e9eac5c 100644 --- a/sdks/python/dropbox_sign/model/fax_line_response.py +++ b/sdks/python/dropbox_sign/model/fax_line_response.py @@ -14,7 +14,6 @@ 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, @@ -121,6 +120,7 @@ def init(data: any) -> FaxLineResponse: _check_type=True, ) + attribute_map = { 'fax_line': 'fax_line', # noqa: E501 'warnings': 'warnings', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/fax_line_response_fax_line.py b/sdks/python/dropbox_sign/model/fax_line_response_fax_line.py index 844b7d771..70cb5c113 100644 --- a/sdks/python/dropbox_sign/model/fax_line_response_fax_line.py +++ b/sdks/python/dropbox_sign/model/fax_line_response_fax_line.py @@ -14,7 +14,6 @@ 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, @@ -120,6 +119,7 @@ def init(data: any) -> FaxLineResponseFaxLine: _check_type=True, ) + attribute_map = { 'number': 'number', # noqa: E501 'created_at': 'created_at', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/file_response.py b/sdks/python/dropbox_sign/model/file_response.py index 1eae681d7..a6c88d9c8 100644 --- a/sdks/python/dropbox_sign/model/file_response.py +++ b/sdks/python/dropbox_sign/model/file_response.py @@ -14,7 +14,6 @@ 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, @@ -110,6 +109,7 @@ def init(data: any) -> FileResponse: _check_type=True, ) + attribute_map = { 'file_url': 'file_url', # noqa: E501 'expires_at': 'expires_at', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/file_response_data_uri.py b/sdks/python/dropbox_sign/model/file_response_data_uri.py index f103c7fcf..6aa9c5c43 100644 --- a/sdks/python/dropbox_sign/model/file_response_data_uri.py +++ b/sdks/python/dropbox_sign/model/file_response_data_uri.py @@ -14,7 +14,6 @@ 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, @@ -109,6 +108,7 @@ def init(data: any) -> FileResponseDataUri: _check_type=True, ) + attribute_map = { 'data_uri': 'data_uri', # noqa: E501 } diff --git a/sdks/python/dropbox_sign/model/list_info_response.py b/sdks/python/dropbox_sign/model/list_info_response.py index b50762f6d..a79388d6d 100644 --- a/sdks/python/dropbox_sign/model/list_info_response.py +++ b/sdks/python/dropbox_sign/model/list_info_response.py @@ -14,7 +14,6 @@ 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, @@ -112,6 +111,7 @@ def init(data: any) -> ListInfoResponse: _check_type=True, ) + attribute_map = { 'num_pages': 'num_pages', # noqa: E501 'num_results': 'num_results', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/o_auth_token_generate_request.py b/sdks/python/dropbox_sign/model/o_auth_token_generate_request.py index 40269de78..a5c385e84 100644 --- a/sdks/python/dropbox_sign/model/o_auth_token_generate_request.py +++ b/sdks/python/dropbox_sign/model/o_auth_token_generate_request.py @@ -14,7 +14,6 @@ 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, @@ -113,6 +112,7 @@ def init(data: any) -> OAuthTokenGenerateRequest: _check_type=True, ) + attribute_map = { 'client_id': 'client_id', # noqa: E501 'client_secret': 'client_secret', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/o_auth_token_refresh_request.py b/sdks/python/dropbox_sign/model/o_auth_token_refresh_request.py index 6165d395a..97ee16b03 100644 --- a/sdks/python/dropbox_sign/model/o_auth_token_refresh_request.py +++ b/sdks/python/dropbox_sign/model/o_auth_token_refresh_request.py @@ -14,7 +14,6 @@ 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, @@ -110,6 +109,7 @@ def init(data: any) -> OAuthTokenRefreshRequest: _check_type=True, ) + attribute_map = { 'grant_type': 'grant_type', # noqa: E501 'refresh_token': 'refresh_token', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/o_auth_token_response.py b/sdks/python/dropbox_sign/model/o_auth_token_response.py index 56faff819..cfe959f0f 100644 --- a/sdks/python/dropbox_sign/model/o_auth_token_response.py +++ b/sdks/python/dropbox_sign/model/o_auth_token_response.py @@ -14,7 +14,6 @@ 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, @@ -113,6 +112,7 @@ def init(data: any) -> OAuthTokenResponse: _check_type=True, ) + attribute_map = { 'access_token': 'access_token', # noqa: E501 'token_type': 'token_type', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/report_create_request.py b/sdks/python/dropbox_sign/model/report_create_request.py index 7a749faed..fe244800d 100644 --- a/sdks/python/dropbox_sign/model/report_create_request.py +++ b/sdks/python/dropbox_sign/model/report_create_request.py @@ -14,7 +14,6 @@ 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, @@ -119,6 +118,7 @@ def init(data: any) -> ReportCreateRequest: _check_type=True, ) + attribute_map = { 'end_date': 'end_date', # noqa: E501 'report_type': 'report_type', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/report_create_response.py b/sdks/python/dropbox_sign/model/report_create_response.py index 6c6c14c92..899de22f0 100644 --- a/sdks/python/dropbox_sign/model/report_create_response.py +++ b/sdks/python/dropbox_sign/model/report_create_response.py @@ -14,7 +14,6 @@ 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, @@ -121,6 +120,7 @@ def init(data: any) -> ReportCreateResponse: _check_type=True, ) + attribute_map = { 'report': 'report', # noqa: E501 'warnings': 'warnings', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/report_response.py b/sdks/python/dropbox_sign/model/report_response.py index 2ac5c4da8..3a5d2d489 100644 --- a/sdks/python/dropbox_sign/model/report_response.py +++ b/sdks/python/dropbox_sign/model/report_response.py @@ -14,7 +14,6 @@ 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, @@ -116,6 +115,7 @@ def init(data: any) -> ReportResponse: _check_type=True, ) + attribute_map = { 'success': 'success', # noqa: E501 'start_date': 'start_date', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/signature_request_bulk_create_embedded_with_template_request.py b/sdks/python/dropbox_sign/model/signature_request_bulk_create_embedded_with_template_request.py index 5ec551848..34772a6c1 100644 --- a/sdks/python/dropbox_sign/model/signature_request_bulk_create_embedded_with_template_request.py +++ b/sdks/python/dropbox_sign/model/signature_request_bulk_create_embedded_with_template_request.py @@ -14,7 +14,6 @@ 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, @@ -146,6 +145,7 @@ def init(data: any) -> SignatureRequestBulkCreateEmbeddedWithTemplateRequest: _check_type=True, ) + attribute_map = { 'template_ids': 'template_ids', # noqa: E501 'client_id': 'client_id', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/signature_request_bulk_send_with_template_request.py b/sdks/python/dropbox_sign/model/signature_request_bulk_send_with_template_request.py index ff6b3f3fa..8e6db6fab 100644 --- a/sdks/python/dropbox_sign/model/signature_request_bulk_send_with_template_request.py +++ b/sdks/python/dropbox_sign/model/signature_request_bulk_send_with_template_request.py @@ -14,7 +14,6 @@ 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, @@ -146,6 +145,7 @@ def init(data: any) -> SignatureRequestBulkSendWithTemplateRequest: _check_type=True, ) + attribute_map = { 'template_ids': 'template_ids', # noqa: E501 'signer_file': 'signer_file', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/signature_request_create_embedded_request.py b/sdks/python/dropbox_sign/model/signature_request_create_embedded_request.py index 962e24c33..1652e2201 100644 --- a/sdks/python/dropbox_sign/model/signature_request_create_embedded_request.py +++ b/sdks/python/dropbox_sign/model/signature_request_create_embedded_request.py @@ -14,7 +14,6 @@ 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, @@ -175,6 +174,7 @@ def init(data: any) -> SignatureRequestCreateEmbeddedRequest: _check_type=True, ) + attribute_map = { 'client_id': 'client_id', # noqa: E501 'files': 'files', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/signature_request_create_embedded_with_template_request.py b/sdks/python/dropbox_sign/model/signature_request_create_embedded_with_template_request.py index 437351b7a..1de11ec8c 100644 --- a/sdks/python/dropbox_sign/model/signature_request_create_embedded_with_template_request.py +++ b/sdks/python/dropbox_sign/model/signature_request_create_embedded_with_template_request.py @@ -14,7 +14,6 @@ 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, @@ -151,6 +150,7 @@ def init(data: any) -> SignatureRequestCreateEmbeddedWithTemplateRequest: _check_type=True, ) + attribute_map = { 'template_ids': 'template_ids', # noqa: E501 'client_id': 'client_id', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/signature_request_get_response.py b/sdks/python/dropbox_sign/model/signature_request_get_response.py index c07ff1d2b..3431f8055 100644 --- a/sdks/python/dropbox_sign/model/signature_request_get_response.py +++ b/sdks/python/dropbox_sign/model/signature_request_get_response.py @@ -14,7 +14,6 @@ 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, @@ -121,6 +120,7 @@ def init(data: any) -> SignatureRequestGetResponse: _check_type=True, ) + attribute_map = { 'signature_request': 'signature_request', # noqa: E501 'warnings': 'warnings', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/signature_request_list_response.py b/sdks/python/dropbox_sign/model/signature_request_list_response.py index a6f5fbe93..770d9d1e2 100644 --- a/sdks/python/dropbox_sign/model/signature_request_list_response.py +++ b/sdks/python/dropbox_sign/model/signature_request_list_response.py @@ -14,7 +14,6 @@ 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, @@ -125,6 +124,7 @@ def init(data: any) -> SignatureRequestListResponse: _check_type=True, ) + attribute_map = { 'signature_requests': 'signature_requests', # noqa: E501 'list_info': 'list_info', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/signature_request_remind_request.py b/sdks/python/dropbox_sign/model/signature_request_remind_request.py index ba4dc8476..dd9c6e42a 100644 --- a/sdks/python/dropbox_sign/model/signature_request_remind_request.py +++ b/sdks/python/dropbox_sign/model/signature_request_remind_request.py @@ -14,7 +14,6 @@ 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, @@ -110,6 +109,7 @@ def init(data: any) -> SignatureRequestRemindRequest: _check_type=True, ) + attribute_map = { 'email_address': 'email_address', # noqa: E501 'name': 'name', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/signature_request_response.py b/sdks/python/dropbox_sign/model/signature_request_response.py index 79929fb8b..c5f197b29 100644 --- a/sdks/python/dropbox_sign/model/signature_request_response.py +++ b/sdks/python/dropbox_sign/model/signature_request_response.py @@ -14,7 +14,6 @@ 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, @@ -150,6 +149,7 @@ def init(data: any) -> SignatureRequestResponse: _check_type=True, ) + attribute_map = { 'test_mode': 'test_mode', # noqa: E501 'signature_request_id': 'signature_request_id', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/signature_request_response_attachment.py b/sdks/python/dropbox_sign/model/signature_request_response_attachment.py index 30c68fe80..3dc417b65 100644 --- a/sdks/python/dropbox_sign/model/signature_request_response_attachment.py +++ b/sdks/python/dropbox_sign/model/signature_request_response_attachment.py @@ -14,7 +14,6 @@ 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, @@ -114,6 +113,7 @@ def init(data: any) -> SignatureRequestResponseAttachment: _check_type=True, ) + attribute_map = { 'id': 'id', # noqa: E501 'signer': 'signer', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/signature_request_response_custom_field_base.py b/sdks/python/dropbox_sign/model/signature_request_response_custom_field_base.py index 9ebfcc688..fcc4f198a 100644 --- a/sdks/python/dropbox_sign/model/signature_request_response_custom_field_base.py +++ b/sdks/python/dropbox_sign/model/signature_request_response_custom_field_base.py @@ -14,7 +14,6 @@ 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, @@ -116,6 +115,7 @@ def discriminator(): return None return {'type': val} + attribute_map = { 'type': 'type', # noqa: E501 'name': 'name', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/signature_request_response_custom_field_checkbox.py b/sdks/python/dropbox_sign/model/signature_request_response_custom_field_checkbox.py index 59753987f..ca531adc3 100644 --- a/sdks/python/dropbox_sign/model/signature_request_response_custom_field_checkbox.py +++ b/sdks/python/dropbox_sign/model/signature_request_response_custom_field_checkbox.py @@ -14,7 +14,6 @@ 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, diff --git a/sdks/python/dropbox_sign/model/signature_request_response_custom_field_text.py b/sdks/python/dropbox_sign/model/signature_request_response_custom_field_text.py index bb4aecae4..e33652f1b 100644 --- a/sdks/python/dropbox_sign/model/signature_request_response_custom_field_text.py +++ b/sdks/python/dropbox_sign/model/signature_request_response_custom_field_text.py @@ -14,7 +14,6 @@ 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, diff --git a/sdks/python/dropbox_sign/model/signature_request_response_custom_field_type_enum.py b/sdks/python/dropbox_sign/model/signature_request_response_custom_field_type_enum.py index 5cd1755f4..1de85eeab 100644 --- a/sdks/python/dropbox_sign/model/signature_request_response_custom_field_type_enum.py +++ b/sdks/python/dropbox_sign/model/signature_request_response_custom_field_type_enum.py @@ -14,7 +14,6 @@ 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, diff --git a/sdks/python/dropbox_sign/model/signature_request_response_data_base.py b/sdks/python/dropbox_sign/model/signature_request_response_data_base.py index 78a0ffb69..18b5e97df 100644 --- a/sdks/python/dropbox_sign/model/signature_request_response_data_base.py +++ b/sdks/python/dropbox_sign/model/signature_request_response_data_base.py @@ -14,7 +14,6 @@ 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, @@ -144,6 +143,7 @@ def discriminator(): return None return {'type': val} + attribute_map = { 'api_id': 'api_id', # noqa: E501 'signature_id': 'signature_id', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/signature_request_response_data_type_enum.py b/sdks/python/dropbox_sign/model/signature_request_response_data_type_enum.py index 0e1e8ead4..f24633d27 100644 --- a/sdks/python/dropbox_sign/model/signature_request_response_data_type_enum.py +++ b/sdks/python/dropbox_sign/model/signature_request_response_data_type_enum.py @@ -14,7 +14,6 @@ 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, diff --git a/sdks/python/dropbox_sign/model/signature_request_response_data_value_checkbox.py b/sdks/python/dropbox_sign/model/signature_request_response_data_value_checkbox.py index 92c8072be..5723404ef 100644 --- a/sdks/python/dropbox_sign/model/signature_request_response_data_value_checkbox.py +++ b/sdks/python/dropbox_sign/model/signature_request_response_data_value_checkbox.py @@ -14,7 +14,6 @@ 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, diff --git a/sdks/python/dropbox_sign/model/signature_request_response_data_value_checkbox_merge.py b/sdks/python/dropbox_sign/model/signature_request_response_data_value_checkbox_merge.py index 4ca142c68..41190b9ac 100644 --- a/sdks/python/dropbox_sign/model/signature_request_response_data_value_checkbox_merge.py +++ b/sdks/python/dropbox_sign/model/signature_request_response_data_value_checkbox_merge.py @@ -14,7 +14,6 @@ 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, diff --git a/sdks/python/dropbox_sign/model/signature_request_response_data_value_date_signed.py b/sdks/python/dropbox_sign/model/signature_request_response_data_value_date_signed.py index 542b950d2..80ed96c36 100644 --- a/sdks/python/dropbox_sign/model/signature_request_response_data_value_date_signed.py +++ b/sdks/python/dropbox_sign/model/signature_request_response_data_value_date_signed.py @@ -14,7 +14,6 @@ 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, diff --git a/sdks/python/dropbox_sign/model/signature_request_response_data_value_dropdown.py b/sdks/python/dropbox_sign/model/signature_request_response_data_value_dropdown.py index 1168e8f40..946710f2c 100644 --- a/sdks/python/dropbox_sign/model/signature_request_response_data_value_dropdown.py +++ b/sdks/python/dropbox_sign/model/signature_request_response_data_value_dropdown.py @@ -14,7 +14,6 @@ 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, diff --git a/sdks/python/dropbox_sign/model/signature_request_response_data_value_initials.py b/sdks/python/dropbox_sign/model/signature_request_response_data_value_initials.py index bbc7464f3..6bff3865b 100644 --- a/sdks/python/dropbox_sign/model/signature_request_response_data_value_initials.py +++ b/sdks/python/dropbox_sign/model/signature_request_response_data_value_initials.py @@ -14,7 +14,6 @@ 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, diff --git a/sdks/python/dropbox_sign/model/signature_request_response_data_value_radio.py b/sdks/python/dropbox_sign/model/signature_request_response_data_value_radio.py index 37dff05f4..7eb534e6c 100644 --- a/sdks/python/dropbox_sign/model/signature_request_response_data_value_radio.py +++ b/sdks/python/dropbox_sign/model/signature_request_response_data_value_radio.py @@ -14,7 +14,6 @@ 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, diff --git a/sdks/python/dropbox_sign/model/signature_request_response_data_value_signature.py b/sdks/python/dropbox_sign/model/signature_request_response_data_value_signature.py index afef513ba..cc2dc16ca 100644 --- a/sdks/python/dropbox_sign/model/signature_request_response_data_value_signature.py +++ b/sdks/python/dropbox_sign/model/signature_request_response_data_value_signature.py @@ -14,7 +14,6 @@ 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, diff --git a/sdks/python/dropbox_sign/model/signature_request_response_data_value_text.py b/sdks/python/dropbox_sign/model/signature_request_response_data_value_text.py index 7c2b13f35..18c48d523 100644 --- a/sdks/python/dropbox_sign/model/signature_request_response_data_value_text.py +++ b/sdks/python/dropbox_sign/model/signature_request_response_data_value_text.py @@ -14,7 +14,6 @@ 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, diff --git a/sdks/python/dropbox_sign/model/signature_request_response_data_value_text_merge.py b/sdks/python/dropbox_sign/model/signature_request_response_data_value_text_merge.py index 94deb01e3..afb0a0dd2 100644 --- a/sdks/python/dropbox_sign/model/signature_request_response_data_value_text_merge.py +++ b/sdks/python/dropbox_sign/model/signature_request_response_data_value_text_merge.py @@ -14,7 +14,6 @@ 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, diff --git a/sdks/python/dropbox_sign/model/signature_request_response_signatures.py b/sdks/python/dropbox_sign/model/signature_request_response_signatures.py index e0f54cdb5..f4da2d44a 100644 --- a/sdks/python/dropbox_sign/model/signature_request_response_signatures.py +++ b/sdks/python/dropbox_sign/model/signature_request_response_signatures.py @@ -14,7 +14,6 @@ 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, @@ -127,6 +126,7 @@ def init(data: any) -> SignatureRequestResponseSignatures: _check_type=True, ) + attribute_map = { 'signature_id': 'signature_id', # noqa: E501 'signer_group_guid': 'signer_group_guid', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/signature_request_send_request.py b/sdks/python/dropbox_sign/model/signature_request_send_request.py index ae7860517..1fa91bc49 100644 --- a/sdks/python/dropbox_sign/model/signature_request_send_request.py +++ b/sdks/python/dropbox_sign/model/signature_request_send_request.py @@ -14,7 +14,6 @@ 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, @@ -177,6 +176,7 @@ def init(data: any) -> SignatureRequestSendRequest: _check_type=True, ) + attribute_map = { 'files': 'files', # noqa: E501 'file_urls': 'file_urls', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/signature_request_send_with_template_request.py b/sdks/python/dropbox_sign/model/signature_request_send_with_template_request.py index 63f38d491..10a3c0c25 100644 --- a/sdks/python/dropbox_sign/model/signature_request_send_with_template_request.py +++ b/sdks/python/dropbox_sign/model/signature_request_send_with_template_request.py @@ -14,7 +14,6 @@ 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, @@ -153,6 +152,7 @@ def init(data: any) -> SignatureRequestSendWithTemplateRequest: _check_type=True, ) + attribute_map = { 'template_ids': 'template_ids', # noqa: E501 'signers': 'signers', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/signature_request_update_request.py b/sdks/python/dropbox_sign/model/signature_request_update_request.py index 2b6f2a642..5dbb48586 100644 --- a/sdks/python/dropbox_sign/model/signature_request_update_request.py +++ b/sdks/python/dropbox_sign/model/signature_request_update_request.py @@ -14,7 +14,6 @@ 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, @@ -112,6 +111,7 @@ def init(data: any) -> SignatureRequestUpdateRequest: _check_type=True, ) + attribute_map = { 'signature_id': 'signature_id', # noqa: E501 'email_address': 'email_address', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/sub_attachment.py b/sdks/python/dropbox_sign/model/sub_attachment.py index 04ed80f51..0f5e6f408 100644 --- a/sdks/python/dropbox_sign/model/sub_attachment.py +++ b/sdks/python/dropbox_sign/model/sub_attachment.py @@ -14,7 +14,6 @@ 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, @@ -112,6 +111,7 @@ def init(data: any) -> SubAttachment: _check_type=True, ) + attribute_map = { 'name': 'name', # noqa: E501 'signer_index': 'signer_index', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/sub_bulk_signer_list.py b/sdks/python/dropbox_sign/model/sub_bulk_signer_list.py index b4f515701..acd664551 100644 --- a/sdks/python/dropbox_sign/model/sub_bulk_signer_list.py +++ b/sdks/python/dropbox_sign/model/sub_bulk_signer_list.py @@ -14,7 +14,6 @@ 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, @@ -121,6 +120,7 @@ def init(data: any) -> SubBulkSignerList: _check_type=True, ) + attribute_map = { 'custom_fields': 'custom_fields', # noqa: E501 'signers': 'signers', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/sub_bulk_signer_list_custom_field.py b/sdks/python/dropbox_sign/model/sub_bulk_signer_list_custom_field.py index 994d55a67..ebedaed25 100644 --- a/sdks/python/dropbox_sign/model/sub_bulk_signer_list_custom_field.py +++ b/sdks/python/dropbox_sign/model/sub_bulk_signer_list_custom_field.py @@ -14,7 +14,6 @@ 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, @@ -110,6 +109,7 @@ def init(data: any) -> SubBulkSignerListCustomField: _check_type=True, ) + attribute_map = { 'name': 'name', # noqa: E501 'value': 'value', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/sub_cc.py b/sdks/python/dropbox_sign/model/sub_cc.py index 80ffe2c0a..5fbf0178a 100644 --- a/sdks/python/dropbox_sign/model/sub_cc.py +++ b/sdks/python/dropbox_sign/model/sub_cc.py @@ -14,7 +14,6 @@ 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, @@ -110,6 +109,7 @@ def init(data: any) -> SubCC: _check_type=True, ) + attribute_map = { 'role': 'role', # noqa: E501 'email_address': 'email_address', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/sub_custom_field.py b/sdks/python/dropbox_sign/model/sub_custom_field.py index e6628eed5..d04411fd0 100644 --- a/sdks/python/dropbox_sign/model/sub_custom_field.py +++ b/sdks/python/dropbox_sign/model/sub_custom_field.py @@ -14,7 +14,6 @@ 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, @@ -112,6 +111,7 @@ def init(data: any) -> SubCustomField: _check_type=True, ) + attribute_map = { 'name': 'name', # noqa: E501 'editor': 'editor', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/sub_editor_options.py b/sdks/python/dropbox_sign/model/sub_editor_options.py index 0667a7a1c..3b2efff22 100644 --- a/sdks/python/dropbox_sign/model/sub_editor_options.py +++ b/sdks/python/dropbox_sign/model/sub_editor_options.py @@ -14,7 +14,6 @@ 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, @@ -110,6 +109,7 @@ def init(data: any) -> SubEditorOptions: _check_type=True, ) + attribute_map = { 'allow_edit_signers': 'allow_edit_signers', # noqa: E501 'allow_edit_documents': 'allow_edit_documents', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/sub_field_options.py b/sdks/python/dropbox_sign/model/sub_field_options.py index 39b35c4c1..e54fecdc1 100644 --- a/sdks/python/dropbox_sign/model/sub_field_options.py +++ b/sdks/python/dropbox_sign/model/sub_field_options.py @@ -14,7 +14,6 @@ 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, @@ -117,6 +116,7 @@ def init(data: any) -> SubFieldOptions: _check_type=True, ) + attribute_map = { 'date_format': 'date_format', # noqa: E501 } diff --git a/sdks/python/dropbox_sign/model/sub_form_field_group.py b/sdks/python/dropbox_sign/model/sub_form_field_group.py index eee79a80a..e4ac2e3f0 100644 --- a/sdks/python/dropbox_sign/model/sub_form_field_group.py +++ b/sdks/python/dropbox_sign/model/sub_form_field_group.py @@ -14,7 +14,6 @@ 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, @@ -111,6 +110,7 @@ def init(data: any) -> SubFormFieldGroup: _check_type=True, ) + attribute_map = { 'group_id': 'group_id', # noqa: E501 'group_label': 'group_label', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/sub_form_field_rule.py b/sdks/python/dropbox_sign/model/sub_form_field_rule.py index 6b3833cea..bf8ccf540 100644 --- a/sdks/python/dropbox_sign/model/sub_form_field_rule.py +++ b/sdks/python/dropbox_sign/model/sub_form_field_rule.py @@ -14,7 +14,6 @@ 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, @@ -130,6 +129,7 @@ def init(data: any) -> SubFormFieldRule: _check_type=True, ) + attribute_map = { 'id': 'id', # noqa: E501 'trigger_operator': 'trigger_operator', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/sub_form_field_rule_action.py b/sdks/python/dropbox_sign/model/sub_form_field_rule_action.py index d3b0845c0..b1aa3b39d 100644 --- a/sdks/python/dropbox_sign/model/sub_form_field_rule_action.py +++ b/sdks/python/dropbox_sign/model/sub_form_field_rule_action.py @@ -14,7 +14,6 @@ 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, @@ -116,6 +115,7 @@ def init(data: any) -> SubFormFieldRuleAction: _check_type=True, ) + attribute_map = { 'hidden': 'hidden', # noqa: E501 'type': 'type', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/sub_form_field_rule_trigger.py b/sdks/python/dropbox_sign/model/sub_form_field_rule_trigger.py index 73e918e91..6edb1eeb7 100644 --- a/sdks/python/dropbox_sign/model/sub_form_field_rule_trigger.py +++ b/sdks/python/dropbox_sign/model/sub_form_field_rule_trigger.py @@ -14,7 +14,6 @@ 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, @@ -119,6 +118,7 @@ def init(data: any) -> SubFormFieldRuleTrigger: _check_type=True, ) + attribute_map = { 'id': 'id', # noqa: E501 'operator': 'operator', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/sub_form_fields_per_document_base.py b/sdks/python/dropbox_sign/model/sub_form_fields_per_document_base.py index 405e8fad8..c36655584 100644 --- a/sdks/python/dropbox_sign/model/sub_form_fields_per_document_base.py +++ b/sdks/python/dropbox_sign/model/sub_form_fields_per_document_base.py @@ -14,7 +14,6 @@ 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, @@ -154,6 +153,7 @@ def discriminator(): return None return {'type': val} + attribute_map = { 'document_index': 'document_index', # noqa: E501 'api_id': 'api_id', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/sub_form_fields_per_document_checkbox.py b/sdks/python/dropbox_sign/model/sub_form_fields_per_document_checkbox.py index 8430d4ab2..22533826a 100644 --- a/sdks/python/dropbox_sign/model/sub_form_fields_per_document_checkbox.py +++ b/sdks/python/dropbox_sign/model/sub_form_fields_per_document_checkbox.py @@ -14,7 +14,6 @@ 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, diff --git a/sdks/python/dropbox_sign/model/sub_form_fields_per_document_checkbox_merge.py b/sdks/python/dropbox_sign/model/sub_form_fields_per_document_checkbox_merge.py index 29263c0fc..4ecc90c08 100644 --- a/sdks/python/dropbox_sign/model/sub_form_fields_per_document_checkbox_merge.py +++ b/sdks/python/dropbox_sign/model/sub_form_fields_per_document_checkbox_merge.py @@ -14,7 +14,6 @@ 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, diff --git a/sdks/python/dropbox_sign/model/sub_form_fields_per_document_date_signed.py b/sdks/python/dropbox_sign/model/sub_form_fields_per_document_date_signed.py index ec103c3e8..78735a90f 100644 --- a/sdks/python/dropbox_sign/model/sub_form_fields_per_document_date_signed.py +++ b/sdks/python/dropbox_sign/model/sub_form_fields_per_document_date_signed.py @@ -14,7 +14,6 @@ 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, diff --git a/sdks/python/dropbox_sign/model/sub_form_fields_per_document_dropdown.py b/sdks/python/dropbox_sign/model/sub_form_fields_per_document_dropdown.py index 589f3b5fe..993be98cd 100644 --- a/sdks/python/dropbox_sign/model/sub_form_fields_per_document_dropdown.py +++ b/sdks/python/dropbox_sign/model/sub_form_fields_per_document_dropdown.py @@ -14,7 +14,6 @@ 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, diff --git a/sdks/python/dropbox_sign/model/sub_form_fields_per_document_font_enum.py b/sdks/python/dropbox_sign/model/sub_form_fields_per_document_font_enum.py index 5cb12da80..3b63d8229 100644 --- a/sdks/python/dropbox_sign/model/sub_form_fields_per_document_font_enum.py +++ b/sdks/python/dropbox_sign/model/sub_form_fields_per_document_font_enum.py @@ -14,7 +14,6 @@ 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, diff --git a/sdks/python/dropbox_sign/model/sub_form_fields_per_document_hyperlink.py b/sdks/python/dropbox_sign/model/sub_form_fields_per_document_hyperlink.py index 0de905f32..238d7572e 100644 --- a/sdks/python/dropbox_sign/model/sub_form_fields_per_document_hyperlink.py +++ b/sdks/python/dropbox_sign/model/sub_form_fields_per_document_hyperlink.py @@ -14,7 +14,6 @@ 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, diff --git a/sdks/python/dropbox_sign/model/sub_form_fields_per_document_initials.py b/sdks/python/dropbox_sign/model/sub_form_fields_per_document_initials.py index 174ac3d3a..fafc83347 100644 --- a/sdks/python/dropbox_sign/model/sub_form_fields_per_document_initials.py +++ b/sdks/python/dropbox_sign/model/sub_form_fields_per_document_initials.py @@ -14,7 +14,6 @@ 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, diff --git a/sdks/python/dropbox_sign/model/sub_form_fields_per_document_radio.py b/sdks/python/dropbox_sign/model/sub_form_fields_per_document_radio.py index 8ba630df8..d7384e29c 100644 --- a/sdks/python/dropbox_sign/model/sub_form_fields_per_document_radio.py +++ b/sdks/python/dropbox_sign/model/sub_form_fields_per_document_radio.py @@ -14,7 +14,6 @@ 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, diff --git a/sdks/python/dropbox_sign/model/sub_form_fields_per_document_signature.py b/sdks/python/dropbox_sign/model/sub_form_fields_per_document_signature.py index 6eb9fd37e..f8ca58530 100644 --- a/sdks/python/dropbox_sign/model/sub_form_fields_per_document_signature.py +++ b/sdks/python/dropbox_sign/model/sub_form_fields_per_document_signature.py @@ -14,7 +14,6 @@ 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, diff --git a/sdks/python/dropbox_sign/model/sub_form_fields_per_document_text.py b/sdks/python/dropbox_sign/model/sub_form_fields_per_document_text.py index 41dc9134d..448ce339b 100644 --- a/sdks/python/dropbox_sign/model/sub_form_fields_per_document_text.py +++ b/sdks/python/dropbox_sign/model/sub_form_fields_per_document_text.py @@ -14,7 +14,6 @@ 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, diff --git a/sdks/python/dropbox_sign/model/sub_form_fields_per_document_text_merge.py b/sdks/python/dropbox_sign/model/sub_form_fields_per_document_text_merge.py index 28c1bdcf4..ac655cc3d 100644 --- a/sdks/python/dropbox_sign/model/sub_form_fields_per_document_text_merge.py +++ b/sdks/python/dropbox_sign/model/sub_form_fields_per_document_text_merge.py @@ -14,7 +14,6 @@ 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, diff --git a/sdks/python/dropbox_sign/model/sub_form_fields_per_document_type_enum.py b/sdks/python/dropbox_sign/model/sub_form_fields_per_document_type_enum.py index 163d05240..dc8a877bd 100644 --- a/sdks/python/dropbox_sign/model/sub_form_fields_per_document_type_enum.py +++ b/sdks/python/dropbox_sign/model/sub_form_fields_per_document_type_enum.py @@ -14,7 +14,6 @@ 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, diff --git a/sdks/python/dropbox_sign/model/sub_merge_field.py b/sdks/python/dropbox_sign/model/sub_merge_field.py index efe798b4d..b256cea94 100644 --- a/sdks/python/dropbox_sign/model/sub_merge_field.py +++ b/sdks/python/dropbox_sign/model/sub_merge_field.py @@ -14,7 +14,6 @@ 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, @@ -114,6 +113,7 @@ def init(data: any) -> SubMergeField: _check_type=True, ) + attribute_map = { 'name': 'name', # noqa: E501 'type': 'type', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/sub_o_auth.py b/sdks/python/dropbox_sign/model/sub_o_auth.py index bbcf95a62..602b6fb89 100644 --- a/sdks/python/dropbox_sign/model/sub_o_auth.py +++ b/sdks/python/dropbox_sign/model/sub_o_auth.py @@ -14,7 +14,6 @@ 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, @@ -120,6 +119,7 @@ def init(data: any) -> SubOAuth: _check_type=True, ) + attribute_map = { 'callback_url': 'callback_url', # noqa: E501 'scopes': 'scopes', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/sub_options.py b/sdks/python/dropbox_sign/model/sub_options.py index 459b44a9a..4e32708fe 100644 --- a/sdks/python/dropbox_sign/model/sub_options.py +++ b/sdks/python/dropbox_sign/model/sub_options.py @@ -14,7 +14,6 @@ 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, @@ -109,6 +108,7 @@ def init(data: any) -> SubOptions: _check_type=True, ) + attribute_map = { 'can_insert_everywhere': 'can_insert_everywhere', # noqa: E501 } diff --git a/sdks/python/dropbox_sign/model/sub_signature_request_grouped_signers.py b/sdks/python/dropbox_sign/model/sub_signature_request_grouped_signers.py index 168ed3273..a53d7da62 100644 --- a/sdks/python/dropbox_sign/model/sub_signature_request_grouped_signers.py +++ b/sdks/python/dropbox_sign/model/sub_signature_request_grouped_signers.py @@ -14,7 +14,6 @@ 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, @@ -119,6 +118,7 @@ def init(data: any) -> SubSignatureRequestGroupedSigners: _check_type=True, ) + attribute_map = { 'group': 'group', # noqa: E501 'signers': 'signers', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/sub_signature_request_signer.py b/sdks/python/dropbox_sign/model/sub_signature_request_signer.py index 71ffb82f2..f6beed4b4 100644 --- a/sdks/python/dropbox_sign/model/sub_signature_request_signer.py +++ b/sdks/python/dropbox_sign/model/sub_signature_request_signer.py @@ -14,7 +14,6 @@ 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, @@ -122,6 +121,7 @@ def init(data: any) -> SubSignatureRequestSigner: _check_type=True, ) + attribute_map = { 'name': 'name', # noqa: E501 'email_address': 'email_address', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/sub_signature_request_template_signer.py b/sdks/python/dropbox_sign/model/sub_signature_request_template_signer.py index 5d9b3ac49..79b47f2b9 100644 --- a/sdks/python/dropbox_sign/model/sub_signature_request_template_signer.py +++ b/sdks/python/dropbox_sign/model/sub_signature_request_template_signer.py @@ -14,7 +14,6 @@ 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, @@ -122,6 +121,7 @@ def init(data: any) -> SubSignatureRequestTemplateSigner: _check_type=True, ) + attribute_map = { 'role': 'role', # noqa: E501 'name': 'name', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/sub_signing_options.py b/sdks/python/dropbox_sign/model/sub_signing_options.py index 9b47da993..5936f0808 100644 --- a/sdks/python/dropbox_sign/model/sub_signing_options.py +++ b/sdks/python/dropbox_sign/model/sub_signing_options.py @@ -14,7 +14,6 @@ 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, @@ -119,6 +118,7 @@ def init(data: any) -> SubSigningOptions: _check_type=True, ) + attribute_map = { 'default_type': 'default_type', # noqa: E501 'draw': 'draw', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/sub_team_response.py b/sdks/python/dropbox_sign/model/sub_team_response.py index af12a9059..32d550706 100644 --- a/sdks/python/dropbox_sign/model/sub_team_response.py +++ b/sdks/python/dropbox_sign/model/sub_team_response.py @@ -14,7 +14,6 @@ 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, @@ -110,6 +109,7 @@ def init(data: any) -> SubTeamResponse: _check_type=True, ) + attribute_map = { 'team_id': 'team_id', # noqa: E501 'name': 'name', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/sub_template_role.py b/sdks/python/dropbox_sign/model/sub_template_role.py index 5062cc46d..39907c5b6 100644 --- a/sdks/python/dropbox_sign/model/sub_template_role.py +++ b/sdks/python/dropbox_sign/model/sub_template_role.py @@ -14,7 +14,6 @@ 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, @@ -110,6 +109,7 @@ def init(data: any) -> SubTemplateRole: _check_type=True, ) + attribute_map = { 'name': 'name', # noqa: E501 'order': 'order', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/sub_unclaimed_draft_signer.py b/sdks/python/dropbox_sign/model/sub_unclaimed_draft_signer.py index 02a354407..7bd19f544 100644 --- a/sdks/python/dropbox_sign/model/sub_unclaimed_draft_signer.py +++ b/sdks/python/dropbox_sign/model/sub_unclaimed_draft_signer.py @@ -14,7 +14,6 @@ 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, @@ -111,6 +110,7 @@ def init(data: any) -> SubUnclaimedDraftSigner: _check_type=True, ) + attribute_map = { 'email_address': 'email_address', # noqa: E501 'name': 'name', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/sub_unclaimed_draft_template_signer.py b/sdks/python/dropbox_sign/model/sub_unclaimed_draft_template_signer.py index a3730017d..02fbdd265 100644 --- a/sdks/python/dropbox_sign/model/sub_unclaimed_draft_template_signer.py +++ b/sdks/python/dropbox_sign/model/sub_unclaimed_draft_template_signer.py @@ -14,7 +14,6 @@ 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, @@ -111,6 +110,7 @@ def init(data: any) -> SubUnclaimedDraftTemplateSigner: _check_type=True, ) + attribute_map = { 'role': 'role', # noqa: E501 'name': 'name', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/sub_white_labeling_options.py b/sdks/python/dropbox_sign/model/sub_white_labeling_options.py index aff5078ce..6eb89b9c5 100644 --- a/sdks/python/dropbox_sign/model/sub_white_labeling_options.py +++ b/sdks/python/dropbox_sign/model/sub_white_labeling_options.py @@ -14,7 +14,6 @@ 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, @@ -127,6 +126,7 @@ def init(data: any) -> SubWhiteLabelingOptions: _check_type=True, ) + attribute_map = { 'header_background_color': 'header_background_color', # noqa: E501 'legal_version': 'legal_version', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/team_add_member_request.py b/sdks/python/dropbox_sign/model/team_add_member_request.py index 97fbf846d..c74f2c376 100644 --- a/sdks/python/dropbox_sign/model/team_add_member_request.py +++ b/sdks/python/dropbox_sign/model/team_add_member_request.py @@ -14,7 +14,6 @@ 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, @@ -117,6 +116,7 @@ def init(data: any) -> TeamAddMemberRequest: _check_type=True, ) + attribute_map = { 'account_id': 'account_id', # noqa: E501 'email_address': 'email_address', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/team_create_request.py b/sdks/python/dropbox_sign/model/team_create_request.py index 699ad65b6..9cf9ecdc5 100644 --- a/sdks/python/dropbox_sign/model/team_create_request.py +++ b/sdks/python/dropbox_sign/model/team_create_request.py @@ -14,7 +14,6 @@ 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, @@ -109,6 +108,7 @@ def init(data: any) -> TeamCreateRequest: _check_type=True, ) + attribute_map = { 'name': 'name', # noqa: E501 } diff --git a/sdks/python/dropbox_sign/model/team_get_info_response.py b/sdks/python/dropbox_sign/model/team_get_info_response.py index c09088981..f2ca84fc8 100644 --- a/sdks/python/dropbox_sign/model/team_get_info_response.py +++ b/sdks/python/dropbox_sign/model/team_get_info_response.py @@ -14,7 +14,6 @@ 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, @@ -121,6 +120,7 @@ def init(data: any) -> TeamGetInfoResponse: _check_type=True, ) + attribute_map = { 'team': 'team', # noqa: E501 'warnings': 'warnings', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/team_get_response.py b/sdks/python/dropbox_sign/model/team_get_response.py index a3e160d9e..d85c189a0 100644 --- a/sdks/python/dropbox_sign/model/team_get_response.py +++ b/sdks/python/dropbox_sign/model/team_get_response.py @@ -14,7 +14,6 @@ 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, @@ -121,6 +120,7 @@ def init(data: any) -> TeamGetResponse: _check_type=True, ) + attribute_map = { 'team': 'team', # noqa: E501 'warnings': 'warnings', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/team_info_response.py b/sdks/python/dropbox_sign/model/team_info_response.py index 218af993e..77c28d11e 100644 --- a/sdks/python/dropbox_sign/model/team_info_response.py +++ b/sdks/python/dropbox_sign/model/team_info_response.py @@ -14,7 +14,6 @@ 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, @@ -121,6 +120,7 @@ def init(data: any) -> TeamInfoResponse: _check_type=True, ) + attribute_map = { 'team_id': 'team_id', # noqa: E501 'team_parent': 'team_parent', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/team_invite_response.py b/sdks/python/dropbox_sign/model/team_invite_response.py index 80d67d43a..65f05540d 100644 --- a/sdks/python/dropbox_sign/model/team_invite_response.py +++ b/sdks/python/dropbox_sign/model/team_invite_response.py @@ -14,7 +14,6 @@ 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, @@ -114,6 +113,7 @@ def init(data: any) -> TeamInviteResponse: _check_type=True, ) + attribute_map = { 'email_address': 'email_address', # noqa: E501 'team_id': 'team_id', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/team_invites_response.py b/sdks/python/dropbox_sign/model/team_invites_response.py index a8cecf03c..5b8749582 100644 --- a/sdks/python/dropbox_sign/model/team_invites_response.py +++ b/sdks/python/dropbox_sign/model/team_invites_response.py @@ -14,7 +14,6 @@ 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, @@ -121,6 +120,7 @@ def init(data: any) -> TeamInvitesResponse: _check_type=True, ) + attribute_map = { 'team_invites': 'team_invites', # noqa: E501 'warnings': 'warnings', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/team_member_response.py b/sdks/python/dropbox_sign/model/team_member_response.py index d30026580..fc8c9d0a5 100644 --- a/sdks/python/dropbox_sign/model/team_member_response.py +++ b/sdks/python/dropbox_sign/model/team_member_response.py @@ -14,7 +14,6 @@ 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, @@ -111,6 +110,7 @@ def init(data: any) -> TeamMemberResponse: _check_type=True, ) + attribute_map = { 'account_id': 'account_id', # noqa: E501 'email_address': 'email_address', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/team_members_response.py b/sdks/python/dropbox_sign/model/team_members_response.py index 0ff0600cb..50fb12b58 100644 --- a/sdks/python/dropbox_sign/model/team_members_response.py +++ b/sdks/python/dropbox_sign/model/team_members_response.py @@ -14,7 +14,6 @@ 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, @@ -125,6 +124,7 @@ def init(data: any) -> TeamMembersResponse: _check_type=True, ) + attribute_map = { 'team_members': 'team_members', # noqa: E501 'list_info': 'list_info', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/team_parent_response.py b/sdks/python/dropbox_sign/model/team_parent_response.py index bacfe3aaa..2ba7dd4f8 100644 --- a/sdks/python/dropbox_sign/model/team_parent_response.py +++ b/sdks/python/dropbox_sign/model/team_parent_response.py @@ -14,7 +14,6 @@ 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, @@ -110,6 +109,7 @@ def init(data: any) -> TeamParentResponse: _check_type=True, ) + attribute_map = { 'team_id': 'team_id', # noqa: E501 'name': 'name', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/team_remove_member_request.py b/sdks/python/dropbox_sign/model/team_remove_member_request.py index 6f7f9e206..7eb1bb272 100644 --- a/sdks/python/dropbox_sign/model/team_remove_member_request.py +++ b/sdks/python/dropbox_sign/model/team_remove_member_request.py @@ -14,7 +14,6 @@ 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, @@ -119,6 +118,7 @@ def init(data: any) -> TeamRemoveMemberRequest: _check_type=True, ) + attribute_map = { 'account_id': 'account_id', # noqa: E501 'email_address': 'email_address', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/team_response.py b/sdks/python/dropbox_sign/model/team_response.py index 88e2dd590..d7ac13221 100644 --- a/sdks/python/dropbox_sign/model/team_response.py +++ b/sdks/python/dropbox_sign/model/team_response.py @@ -14,7 +14,6 @@ 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, @@ -120,6 +119,7 @@ def init(data: any) -> TeamResponse: _check_type=True, ) + attribute_map = { 'name': 'name', # noqa: E501 'accounts': 'accounts', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/team_sub_teams_response.py b/sdks/python/dropbox_sign/model/team_sub_teams_response.py index 4cad1d428..173cbe67f 100644 --- a/sdks/python/dropbox_sign/model/team_sub_teams_response.py +++ b/sdks/python/dropbox_sign/model/team_sub_teams_response.py @@ -14,7 +14,6 @@ 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, @@ -125,6 +124,7 @@ def init(data: any) -> TeamSubTeamsResponse: _check_type=True, ) + attribute_map = { 'sub_teams': 'sub_teams', # noqa: E501 'list_info': 'list_info', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/team_update_request.py b/sdks/python/dropbox_sign/model/team_update_request.py index be6ca9193..acee5d059 100644 --- a/sdks/python/dropbox_sign/model/team_update_request.py +++ b/sdks/python/dropbox_sign/model/team_update_request.py @@ -14,7 +14,6 @@ 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, @@ -109,6 +108,7 @@ def init(data: any) -> TeamUpdateRequest: _check_type=True, ) + attribute_map = { 'name': 'name', # noqa: E501 } diff --git a/sdks/python/dropbox_sign/model/template_add_user_request.py b/sdks/python/dropbox_sign/model/template_add_user_request.py index b742574df..6fdb406f3 100644 --- a/sdks/python/dropbox_sign/model/template_add_user_request.py +++ b/sdks/python/dropbox_sign/model/template_add_user_request.py @@ -14,7 +14,6 @@ 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, @@ -111,6 +110,7 @@ def init(data: any) -> TemplateAddUserRequest: _check_type=True, ) + attribute_map = { 'account_id': 'account_id', # noqa: E501 'email_address': 'email_address', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/template_create_embedded_draft_request.py b/sdks/python/dropbox_sign/model/template_create_embedded_draft_request.py index b78a53f12..2d7c413f3 100644 --- a/sdks/python/dropbox_sign/model/template_create_embedded_draft_request.py +++ b/sdks/python/dropbox_sign/model/template_create_embedded_draft_request.py @@ -14,7 +14,6 @@ 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, @@ -170,6 +169,7 @@ def init(data: any) -> TemplateCreateEmbeddedDraftRequest: _check_type=True, ) + attribute_map = { 'client_id': 'client_id', # noqa: E501 'files': 'files', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/template_create_embedded_draft_response.py b/sdks/python/dropbox_sign/model/template_create_embedded_draft_response.py index bbc88b1f2..2c444f869 100644 --- a/sdks/python/dropbox_sign/model/template_create_embedded_draft_response.py +++ b/sdks/python/dropbox_sign/model/template_create_embedded_draft_response.py @@ -14,7 +14,6 @@ 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, @@ -121,6 +120,7 @@ def init(data: any) -> TemplateCreateEmbeddedDraftResponse: _check_type=True, ) + attribute_map = { 'template': 'template', # noqa: E501 'warnings': 'warnings', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/template_create_embedded_draft_response_template.py b/sdks/python/dropbox_sign/model/template_create_embedded_draft_response_template.py index cf02872aa..1931b4e03 100644 --- a/sdks/python/dropbox_sign/model/template_create_embedded_draft_response_template.py +++ b/sdks/python/dropbox_sign/model/template_create_embedded_draft_response_template.py @@ -14,7 +14,6 @@ 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, @@ -120,6 +119,7 @@ def init(data: any) -> TemplateCreateEmbeddedDraftResponseTemplate: _check_type=True, ) + attribute_map = { 'template_id': 'template_id', # noqa: E501 'edit_url': 'edit_url', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/template_create_request.py b/sdks/python/dropbox_sign/model/template_create_request.py index 8c9c8e6ac..13ca1ba4d 100644 --- a/sdks/python/dropbox_sign/model/template_create_request.py +++ b/sdks/python/dropbox_sign/model/template_create_request.py @@ -14,7 +14,6 @@ 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, @@ -160,6 +159,7 @@ def init(data: any) -> TemplateCreateRequest: _check_type=True, ) + attribute_map = { 'form_fields_per_document': 'form_fields_per_document', # noqa: E501 'signer_roles': 'signer_roles', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/template_create_response.py b/sdks/python/dropbox_sign/model/template_create_response.py index 46e4df027..ecbe35729 100644 --- a/sdks/python/dropbox_sign/model/template_create_response.py +++ b/sdks/python/dropbox_sign/model/template_create_response.py @@ -14,7 +14,6 @@ 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, @@ -121,6 +120,7 @@ def init(data: any) -> TemplateCreateResponse: _check_type=True, ) + attribute_map = { 'template': 'template', # noqa: E501 'warnings': 'warnings', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/template_create_response_template.py b/sdks/python/dropbox_sign/model/template_create_response_template.py index d80f694f0..947acdc2d 100644 --- a/sdks/python/dropbox_sign/model/template_create_response_template.py +++ b/sdks/python/dropbox_sign/model/template_create_response_template.py @@ -14,7 +14,6 @@ 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, @@ -109,6 +108,7 @@ def init(data: any) -> TemplateCreateResponseTemplate: _check_type=True, ) + attribute_map = { 'template_id': 'template_id', # noqa: E501 } diff --git a/sdks/python/dropbox_sign/model/template_edit_response.py b/sdks/python/dropbox_sign/model/template_edit_response.py index 793e9afba..818582dd0 100644 --- a/sdks/python/dropbox_sign/model/template_edit_response.py +++ b/sdks/python/dropbox_sign/model/template_edit_response.py @@ -14,7 +14,6 @@ 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, @@ -109,6 +108,7 @@ def init(data: any) -> TemplateEditResponse: _check_type=True, ) + attribute_map = { 'template_id': 'template_id', # noqa: E501 } diff --git a/sdks/python/dropbox_sign/model/template_get_response.py b/sdks/python/dropbox_sign/model/template_get_response.py index 7e56c8214..adb6686a8 100644 --- a/sdks/python/dropbox_sign/model/template_get_response.py +++ b/sdks/python/dropbox_sign/model/template_get_response.py @@ -14,7 +14,6 @@ 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, @@ -121,6 +120,7 @@ def init(data: any) -> TemplateGetResponse: _check_type=True, ) + attribute_map = { 'template': 'template', # noqa: E501 'warnings': 'warnings', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/template_list_response.py b/sdks/python/dropbox_sign/model/template_list_response.py index 3c4e01cc4..36dcafc19 100644 --- a/sdks/python/dropbox_sign/model/template_list_response.py +++ b/sdks/python/dropbox_sign/model/template_list_response.py @@ -14,7 +14,6 @@ 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, @@ -125,6 +124,7 @@ def init(data: any) -> TemplateListResponse: _check_type=True, ) + attribute_map = { 'templates': 'templates', # noqa: E501 'list_info': 'list_info', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/template_remove_user_request.py b/sdks/python/dropbox_sign/model/template_remove_user_request.py index b3e192757..acc5eb880 100644 --- a/sdks/python/dropbox_sign/model/template_remove_user_request.py +++ b/sdks/python/dropbox_sign/model/template_remove_user_request.py @@ -14,7 +14,6 @@ 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, @@ -110,6 +109,7 @@ def init(data: any) -> TemplateRemoveUserRequest: _check_type=True, ) + attribute_map = { 'account_id': 'account_id', # noqa: E501 'email_address': 'email_address', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/template_response.py b/sdks/python/dropbox_sign/model/template_response.py index 8a661f48f..a926e1def 100644 --- a/sdks/python/dropbox_sign/model/template_response.py +++ b/sdks/python/dropbox_sign/model/template_response.py @@ -14,7 +14,6 @@ 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, @@ -146,6 +145,7 @@ def init(data: any) -> TemplateResponse: _check_type=True, ) + attribute_map = { 'template_id': 'template_id', # noqa: E501 'title': 'title', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/template_response_account.py b/sdks/python/dropbox_sign/model/template_response_account.py index 311842c25..1693133d1 100644 --- a/sdks/python/dropbox_sign/model/template_response_account.py +++ b/sdks/python/dropbox_sign/model/template_response_account.py @@ -14,7 +14,6 @@ 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, @@ -122,6 +121,7 @@ def init(data: any) -> TemplateResponseAccount: _check_type=True, ) + attribute_map = { 'account_id': 'account_id', # noqa: E501 'email_address': 'email_address', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/template_response_account_quota.py b/sdks/python/dropbox_sign/model/template_response_account_quota.py index 4df5055cf..dc596aaf2 100644 --- a/sdks/python/dropbox_sign/model/template_response_account_quota.py +++ b/sdks/python/dropbox_sign/model/template_response_account_quota.py @@ -14,7 +14,6 @@ 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, @@ -112,6 +111,7 @@ def init(data: any) -> TemplateResponseAccountQuota: _check_type=True, ) + attribute_map = { 'templates_left': 'templates_left', # noqa: E501 'api_signature_requests_left': 'api_signature_requests_left', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/template_response_cc_role.py b/sdks/python/dropbox_sign/model/template_response_cc_role.py index cdec27200..8b0fe6dcc 100644 --- a/sdks/python/dropbox_sign/model/template_response_cc_role.py +++ b/sdks/python/dropbox_sign/model/template_response_cc_role.py @@ -14,7 +14,6 @@ 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, @@ -109,6 +108,7 @@ def init(data: any) -> TemplateResponseCCRole: _check_type=True, ) + attribute_map = { 'name': 'name', # noqa: E501 } diff --git a/sdks/python/dropbox_sign/model/template_response_document.py b/sdks/python/dropbox_sign/model/template_response_document.py index f4043f385..7dfb7ba98 100644 --- a/sdks/python/dropbox_sign/model/template_response_document.py +++ b/sdks/python/dropbox_sign/model/template_response_document.py @@ -14,7 +14,6 @@ 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, @@ -131,6 +130,7 @@ def init(data: any) -> TemplateResponseDocument: _check_type=True, ) + attribute_map = { 'name': 'name', # noqa: E501 'index': 'index', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/template_response_document_custom_field_base.py b/sdks/python/dropbox_sign/model/template_response_document_custom_field_base.py index c27673023..79a8b014f 100644 --- a/sdks/python/dropbox_sign/model/template_response_document_custom_field_base.py +++ b/sdks/python/dropbox_sign/model/template_response_document_custom_field_base.py @@ -14,7 +14,6 @@ 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, @@ -121,6 +120,7 @@ def discriminator(): return None return {'type': val} + attribute_map = { 'type': 'type', # noqa: E501 'api_id': 'api_id', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/template_response_document_custom_field_checkbox.py b/sdks/python/dropbox_sign/model/template_response_document_custom_field_checkbox.py index f69ab917d..fe62210fc 100644 --- a/sdks/python/dropbox_sign/model/template_response_document_custom_field_checkbox.py +++ b/sdks/python/dropbox_sign/model/template_response_document_custom_field_checkbox.py @@ -14,7 +14,6 @@ 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, diff --git a/sdks/python/dropbox_sign/model/template_response_document_custom_field_text.py b/sdks/python/dropbox_sign/model/template_response_document_custom_field_text.py index 6989c1db4..725c49a70 100644 --- a/sdks/python/dropbox_sign/model/template_response_document_custom_field_text.py +++ b/sdks/python/dropbox_sign/model/template_response_document_custom_field_text.py @@ -14,7 +14,6 @@ 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, diff --git a/sdks/python/dropbox_sign/model/template_response_document_field_group.py b/sdks/python/dropbox_sign/model/template_response_document_field_group.py index 675fd8771..e3bcfca84 100644 --- a/sdks/python/dropbox_sign/model/template_response_document_field_group.py +++ b/sdks/python/dropbox_sign/model/template_response_document_field_group.py @@ -14,7 +14,6 @@ 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, @@ -118,6 +117,7 @@ def init(data: any) -> TemplateResponseDocumentFieldGroup: _check_type=True, ) + attribute_map = { 'name': 'name', # noqa: E501 'rule': 'rule', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/template_response_document_field_group_rule.py b/sdks/python/dropbox_sign/model/template_response_document_field_group_rule.py index a542c3135..4dc956ccd 100644 --- a/sdks/python/dropbox_sign/model/template_response_document_field_group_rule.py +++ b/sdks/python/dropbox_sign/model/template_response_document_field_group_rule.py @@ -14,7 +14,6 @@ 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, @@ -110,6 +109,7 @@ def init(data: any) -> TemplateResponseDocumentFieldGroupRule: _check_type=True, ) + attribute_map = { 'requirement': 'requirement', # noqa: E501 'group_label': 'groupLabel', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/template_response_document_form_field_base.py b/sdks/python/dropbox_sign/model/template_response_document_form_field_base.py index 41fcb3222..2194f6c59 100644 --- a/sdks/python/dropbox_sign/model/template_response_document_form_field_base.py +++ b/sdks/python/dropbox_sign/model/template_response_document_form_field_base.py @@ -14,7 +14,6 @@ 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, @@ -145,6 +144,7 @@ def discriminator(): return None return {'type': val} + attribute_map = { 'type': 'type', # noqa: E501 'api_id': 'api_id', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/template_response_document_form_field_checkbox.py b/sdks/python/dropbox_sign/model/template_response_document_form_field_checkbox.py index 732d93e97..176630f42 100644 --- a/sdks/python/dropbox_sign/model/template_response_document_form_field_checkbox.py +++ b/sdks/python/dropbox_sign/model/template_response_document_form_field_checkbox.py @@ -14,7 +14,6 @@ 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, diff --git a/sdks/python/dropbox_sign/model/template_response_document_form_field_date_signed.py b/sdks/python/dropbox_sign/model/template_response_document_form_field_date_signed.py index e6b00a11a..ce632dd03 100644 --- a/sdks/python/dropbox_sign/model/template_response_document_form_field_date_signed.py +++ b/sdks/python/dropbox_sign/model/template_response_document_form_field_date_signed.py @@ -14,7 +14,6 @@ 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, diff --git a/sdks/python/dropbox_sign/model/template_response_document_form_field_dropdown.py b/sdks/python/dropbox_sign/model/template_response_document_form_field_dropdown.py index 148a53f46..3aa4cf05b 100644 --- a/sdks/python/dropbox_sign/model/template_response_document_form_field_dropdown.py +++ b/sdks/python/dropbox_sign/model/template_response_document_form_field_dropdown.py @@ -14,7 +14,6 @@ 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, diff --git a/sdks/python/dropbox_sign/model/template_response_document_form_field_hyperlink.py b/sdks/python/dropbox_sign/model/template_response_document_form_field_hyperlink.py index 28905138e..5ebb3bfc9 100644 --- a/sdks/python/dropbox_sign/model/template_response_document_form_field_hyperlink.py +++ b/sdks/python/dropbox_sign/model/template_response_document_form_field_hyperlink.py @@ -14,7 +14,6 @@ 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, diff --git a/sdks/python/dropbox_sign/model/template_response_document_form_field_initials.py b/sdks/python/dropbox_sign/model/template_response_document_form_field_initials.py index 63e941b1f..4d7771f35 100644 --- a/sdks/python/dropbox_sign/model/template_response_document_form_field_initials.py +++ b/sdks/python/dropbox_sign/model/template_response_document_form_field_initials.py @@ -14,7 +14,6 @@ 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, diff --git a/sdks/python/dropbox_sign/model/template_response_document_form_field_radio.py b/sdks/python/dropbox_sign/model/template_response_document_form_field_radio.py index fd0889178..ef0c4b4ae 100644 --- a/sdks/python/dropbox_sign/model/template_response_document_form_field_radio.py +++ b/sdks/python/dropbox_sign/model/template_response_document_form_field_radio.py @@ -14,7 +14,6 @@ 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, diff --git a/sdks/python/dropbox_sign/model/template_response_document_form_field_signature.py b/sdks/python/dropbox_sign/model/template_response_document_form_field_signature.py index 8c8383368..3d58e79ed 100644 --- a/sdks/python/dropbox_sign/model/template_response_document_form_field_signature.py +++ b/sdks/python/dropbox_sign/model/template_response_document_form_field_signature.py @@ -14,7 +14,6 @@ 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, diff --git a/sdks/python/dropbox_sign/model/template_response_document_form_field_text.py b/sdks/python/dropbox_sign/model/template_response_document_form_field_text.py index 228cd748a..7487e8bce 100644 --- a/sdks/python/dropbox_sign/model/template_response_document_form_field_text.py +++ b/sdks/python/dropbox_sign/model/template_response_document_form_field_text.py @@ -14,7 +14,6 @@ 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, diff --git a/sdks/python/dropbox_sign/model/template_response_document_static_field_base.py b/sdks/python/dropbox_sign/model/template_response_document_static_field_base.py index e6d4889be..b1c092e1e 100644 --- a/sdks/python/dropbox_sign/model/template_response_document_static_field_base.py +++ b/sdks/python/dropbox_sign/model/template_response_document_static_field_base.py @@ -14,7 +14,6 @@ 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, @@ -145,6 +144,7 @@ def discriminator(): return None return {'type': val} + attribute_map = { 'type': 'type', # noqa: E501 'api_id': 'api_id', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/template_response_document_static_field_checkbox.py b/sdks/python/dropbox_sign/model/template_response_document_static_field_checkbox.py index c2ef91014..19a4cf297 100644 --- a/sdks/python/dropbox_sign/model/template_response_document_static_field_checkbox.py +++ b/sdks/python/dropbox_sign/model/template_response_document_static_field_checkbox.py @@ -14,7 +14,6 @@ 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, diff --git a/sdks/python/dropbox_sign/model/template_response_document_static_field_date_signed.py b/sdks/python/dropbox_sign/model/template_response_document_static_field_date_signed.py index a4dcac48c..e9d724d0c 100644 --- a/sdks/python/dropbox_sign/model/template_response_document_static_field_date_signed.py +++ b/sdks/python/dropbox_sign/model/template_response_document_static_field_date_signed.py @@ -14,7 +14,6 @@ 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, diff --git a/sdks/python/dropbox_sign/model/template_response_document_static_field_dropdown.py b/sdks/python/dropbox_sign/model/template_response_document_static_field_dropdown.py index 666c01c70..c5afa1746 100644 --- a/sdks/python/dropbox_sign/model/template_response_document_static_field_dropdown.py +++ b/sdks/python/dropbox_sign/model/template_response_document_static_field_dropdown.py @@ -14,7 +14,6 @@ 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, diff --git a/sdks/python/dropbox_sign/model/template_response_document_static_field_hyperlink.py b/sdks/python/dropbox_sign/model/template_response_document_static_field_hyperlink.py index 0b25b795e..e2d72f2bb 100644 --- a/sdks/python/dropbox_sign/model/template_response_document_static_field_hyperlink.py +++ b/sdks/python/dropbox_sign/model/template_response_document_static_field_hyperlink.py @@ -14,7 +14,6 @@ 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, diff --git a/sdks/python/dropbox_sign/model/template_response_document_static_field_initials.py b/sdks/python/dropbox_sign/model/template_response_document_static_field_initials.py index c9a85a8a5..dfd51cb7a 100644 --- a/sdks/python/dropbox_sign/model/template_response_document_static_field_initials.py +++ b/sdks/python/dropbox_sign/model/template_response_document_static_field_initials.py @@ -14,7 +14,6 @@ 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, diff --git a/sdks/python/dropbox_sign/model/template_response_document_static_field_radio.py b/sdks/python/dropbox_sign/model/template_response_document_static_field_radio.py index ac524bf90..11cf70a60 100644 --- a/sdks/python/dropbox_sign/model/template_response_document_static_field_radio.py +++ b/sdks/python/dropbox_sign/model/template_response_document_static_field_radio.py @@ -14,7 +14,6 @@ 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, diff --git a/sdks/python/dropbox_sign/model/template_response_document_static_field_signature.py b/sdks/python/dropbox_sign/model/template_response_document_static_field_signature.py index f395397fd..c33578ad6 100644 --- a/sdks/python/dropbox_sign/model/template_response_document_static_field_signature.py +++ b/sdks/python/dropbox_sign/model/template_response_document_static_field_signature.py @@ -14,7 +14,6 @@ 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, diff --git a/sdks/python/dropbox_sign/model/template_response_document_static_field_text.py b/sdks/python/dropbox_sign/model/template_response_document_static_field_text.py index 88f4e4607..13c5e23c2 100644 --- a/sdks/python/dropbox_sign/model/template_response_document_static_field_text.py +++ b/sdks/python/dropbox_sign/model/template_response_document_static_field_text.py @@ -14,7 +14,6 @@ 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, diff --git a/sdks/python/dropbox_sign/model/template_response_field_avg_text_length.py b/sdks/python/dropbox_sign/model/template_response_field_avg_text_length.py index f5474c70c..8629c383f 100644 --- a/sdks/python/dropbox_sign/model/template_response_field_avg_text_length.py +++ b/sdks/python/dropbox_sign/model/template_response_field_avg_text_length.py @@ -14,7 +14,6 @@ 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, @@ -110,6 +109,7 @@ def init(data: any) -> TemplateResponseFieldAvgTextLength: _check_type=True, ) + attribute_map = { 'num_lines': 'num_lines', # noqa: E501 'num_chars_per_line': 'num_chars_per_line', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/template_response_signer_role.py b/sdks/python/dropbox_sign/model/template_response_signer_role.py index d2588795e..31cc0a863 100644 --- a/sdks/python/dropbox_sign/model/template_response_signer_role.py +++ b/sdks/python/dropbox_sign/model/template_response_signer_role.py @@ -14,7 +14,6 @@ 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, @@ -110,6 +109,7 @@ def init(data: any) -> TemplateResponseSignerRole: _check_type=True, ) + attribute_map = { 'name': 'name', # noqa: E501 'order': 'order', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/template_update_files_request.py b/sdks/python/dropbox_sign/model/template_update_files_request.py index cb7439b48..57781c21d 100644 --- a/sdks/python/dropbox_sign/model/template_update_files_request.py +++ b/sdks/python/dropbox_sign/model/template_update_files_request.py @@ -14,7 +14,6 @@ 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, @@ -120,6 +119,7 @@ def init(data: any) -> TemplateUpdateFilesRequest: _check_type=True, ) + attribute_map = { 'client_id': 'client_id', # noqa: E501 'files': 'files', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/template_update_files_response.py b/sdks/python/dropbox_sign/model/template_update_files_response.py index 7bd63545a..caad0c376 100644 --- a/sdks/python/dropbox_sign/model/template_update_files_response.py +++ b/sdks/python/dropbox_sign/model/template_update_files_response.py @@ -14,7 +14,6 @@ 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, @@ -117,6 +116,7 @@ def init(data: any) -> TemplateUpdateFilesResponse: _check_type=True, ) + attribute_map = { 'template': 'template', # noqa: E501 } diff --git a/sdks/python/dropbox_sign/model/template_update_files_response_template.py b/sdks/python/dropbox_sign/model/template_update_files_response_template.py index fca68302b..9a9116676 100644 --- a/sdks/python/dropbox_sign/model/template_update_files_response_template.py +++ b/sdks/python/dropbox_sign/model/template_update_files_response_template.py @@ -14,7 +14,6 @@ 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, @@ -118,6 +117,7 @@ def init(data: any) -> TemplateUpdateFilesResponseTemplate: _check_type=True, ) + attribute_map = { 'template_id': 'template_id', # noqa: E501 'warnings': 'warnings', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/unclaimed_draft_create_embedded_request.py b/sdks/python/dropbox_sign/model/unclaimed_draft_create_embedded_request.py index 5aba8dbb2..f0f5ab40a 100644 --- a/sdks/python/dropbox_sign/model/unclaimed_draft_create_embedded_request.py +++ b/sdks/python/dropbox_sign/model/unclaimed_draft_create_embedded_request.py @@ -14,7 +14,6 @@ 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, @@ -188,6 +187,7 @@ def init(data: any) -> UnclaimedDraftCreateEmbeddedRequest: _check_type=True, ) + attribute_map = { 'client_id': 'client_id', # noqa: E501 'requester_email_address': 'requester_email_address', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/unclaimed_draft_create_embedded_with_template_request.py b/sdks/python/dropbox_sign/model/unclaimed_draft_create_embedded_with_template_request.py index 6c3a935d2..57f1ef526 100644 --- a/sdks/python/dropbox_sign/model/unclaimed_draft_create_embedded_with_template_request.py +++ b/sdks/python/dropbox_sign/model/unclaimed_draft_create_embedded_with_template_request.py @@ -14,7 +14,6 @@ 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, @@ -172,6 +171,7 @@ def init(data: any) -> UnclaimedDraftCreateEmbeddedWithTemplateRequest: _check_type=True, ) + attribute_map = { 'client_id': 'client_id', # noqa: E501 'requester_email_address': 'requester_email_address', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/unclaimed_draft_create_request.py b/sdks/python/dropbox_sign/model/unclaimed_draft_create_request.py index 960d727c9..829176dbf 100644 --- a/sdks/python/dropbox_sign/model/unclaimed_draft_create_request.py +++ b/sdks/python/dropbox_sign/model/unclaimed_draft_create_request.py @@ -14,7 +14,6 @@ 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, @@ -173,6 +172,7 @@ def init(data: any) -> UnclaimedDraftCreateRequest: _check_type=True, ) + attribute_map = { 'type': 'type', # noqa: E501 'files': 'files', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/unclaimed_draft_create_response.py b/sdks/python/dropbox_sign/model/unclaimed_draft_create_response.py index d2c585e42..eb5f1c23c 100644 --- a/sdks/python/dropbox_sign/model/unclaimed_draft_create_response.py +++ b/sdks/python/dropbox_sign/model/unclaimed_draft_create_response.py @@ -14,7 +14,6 @@ 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, @@ -121,6 +120,7 @@ def init(data: any) -> UnclaimedDraftCreateResponse: _check_type=True, ) + attribute_map = { 'unclaimed_draft': 'unclaimed_draft', # noqa: E501 'warnings': 'warnings', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/unclaimed_draft_edit_and_resend_request.py b/sdks/python/dropbox_sign/model/unclaimed_draft_edit_and_resend_request.py index 3ddf62f69..d38186bab 100644 --- a/sdks/python/dropbox_sign/model/unclaimed_draft_edit_and_resend_request.py +++ b/sdks/python/dropbox_sign/model/unclaimed_draft_edit_and_resend_request.py @@ -14,7 +14,6 @@ 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, @@ -124,6 +123,7 @@ def init(data: any) -> UnclaimedDraftEditAndResendRequest: _check_type=True, ) + attribute_map = { 'client_id': 'client_id', # noqa: E501 'editor_options': 'editor_options', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/unclaimed_draft_response.py b/sdks/python/dropbox_sign/model/unclaimed_draft_response.py index 158e96f0d..03c72fcb1 100644 --- a/sdks/python/dropbox_sign/model/unclaimed_draft_response.py +++ b/sdks/python/dropbox_sign/model/unclaimed_draft_response.py @@ -14,7 +14,6 @@ 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, @@ -114,6 +113,7 @@ def init(data: any) -> UnclaimedDraftResponse: _check_type=True, ) + attribute_map = { 'signature_request_id': 'signature_request_id', # noqa: E501 'claim_url': 'claim_url', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model/warning_response.py b/sdks/python/dropbox_sign/model/warning_response.py index eb6276670..d2fbd3f1f 100644 --- a/sdks/python/dropbox_sign/model/warning_response.py +++ b/sdks/python/dropbox_sign/model/warning_response.py @@ -14,7 +14,6 @@ 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, @@ -110,6 +109,7 @@ def init(data: any) -> WarningResponse: _check_type=True, ) + attribute_map = { 'warning_msg': 'warning_msg', # noqa: E501 'warning_name': 'warning_name', # noqa: E501 diff --git a/sdks/python/dropbox_sign/model_utils.py b/sdks/python/dropbox_sign/model_utils.py index 7b89acc17..b2e911963 100644 --- a/sdks/python/dropbox_sign/model_utils.py +++ b/sdks/python/dropbox_sign/model_utils.py @@ -1107,7 +1107,6 @@ def remove_uncoercible(required_types_classes, current_item, spec_property_namin # leave ints as-is if type(current_item) is int and required_type_class_simplified == current_type_simple: results_classes.append(int) - if required_type_class_simplified == current_type_simple: # don't consider converting to one's own class continue @@ -1117,7 +1116,6 @@ def remove_uncoercible(required_types_classes, current_item, spec_property_namin results_classes.append(required_type_class) elif class_pair in UPCONVERSION_TYPE_PAIRS: results_classes.append(required_type_class) - # allow casting int to string if type(current_item) is int: results_classes.append(str) @@ -1451,7 +1449,6 @@ def attempt_convert_item(input_value, valid_classes, path_to_item, if not valid_classes_coercible or key_type: if input_value is None: return input_value - # we do not handle keytype errors, json will take care # of this for us if configuration is None or not configuration.discard_unknown_keys: @@ -1700,7 +1697,6 @@ def model_to_dict(model_instance, serialize=True): return result - def model_to_dict_recursive(value, serialize, extract_item): if isinstance(value, list): res = [] @@ -2039,4 +2035,4 @@ def validate_get_composed_info(constant_args, model_args, self): var_name_to_model_instances, additional_properties_model_instances, discarded_args - ] \ No newline at end of file + ] diff --git a/sdks/python/dropbox_sign/rest.py b/sdks/python/dropbox_sign/rest.py index 4f01302fd..005879fc3 100644 --- a/sdks/python/dropbox_sign/rest.py +++ b/sdks/python/dropbox_sign/rest.py @@ -36,11 +36,11 @@ def __init__(self, resp): def getheaders(self): """Returns a dictionary of the response headers.""" - return self.urllib3_response.headers + return self.urllib3_response.getheaders() def getheader(self, name, default=None): """Returns a given response header.""" - return self.urllib3_response.headers.get(name, default) + return self.urllib3_response.getheader(name, default) class RESTClientObject(object): diff --git a/sdks/python/openapi-config.yaml b/sdks/python/openapi-config.yaml index 43c6d710c..3bd18d629 100644 --- a/sdks/python/openapi-config.yaml +++ b/sdks/python/openapi-config.yaml @@ -10,6 +10,7 @@ additionalProperties: packageAuthor: Dropbox Sign API Team packageUrl: https://github.com/hellosign/dropbox-sign-python infoName: Official Python SDK for the Dropbox Sign API + useCustomTemplateCode: true files: event_callback_helper.mustache: templateType: SupportingFiles diff --git a/sdks/python/run-build b/sdks/python/run-build index aa54ddea0..2f30b4783 100755 --- a/sdks/python/run-build +++ b/sdks/python/run-build @@ -1,12 +1,13 @@ #!/usr/bin/env bash -# see https://github.com/OpenAPITools/openapi-generator/tree/8b3cad0692b6c58f827c0a9b35f1ad733547504b/modules/openapi-generator/src/main/resources/python +# see https://github.com/OpenAPITools/openapi-generator/tree/v5.4.0/modules/openapi-generator/src/main/resources/python set -e DIR=$(cd `dirname $0` && pwd) WORKING_DIR="/app/python" +# must use v5.3.0 generator as v5.4.0 has a bug preventing generating SDK docker run --rm \ -v "${DIR}/:/local" \ openapitools/openapi-generator-cli:v5.3.0 generate \ diff --git a/sdks/python/templates/README.mustache b/sdks/python/templates/README.mustache index a8e53c571..ed6bdcd29 100644 --- a/sdks/python/templates/README.mustache +++ b/sdks/python/templates/README.mustache @@ -1,9 +1,50 @@ # {{{projectName}}} - {{#appDescriptionWithNewLines}} {{{.}}} {{/appDescriptionWithNewLines}} +{{^useCustomTemplateCode}} +This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: + +- API version: {{appVersion}} +- Package version: {{packageVersion}} +{{^hideGenerationTimestamp}} +- Build date: {{generatedDate}} +{{/hideGenerationTimestamp}} +- Build package: {{generatorClass}} +{{#infoUrl}} +For more information, please visit [{{{infoUrl}}}]({{{infoUrl}}}) +{{/infoUrl}} + +## Requirements. + +Python {{{generatorLanguageVersion}}} + +## Installation & Usage +### pip install + +If the python package is hosted on a repository, you can install directly using: + +```sh +pip install git+https://{{gitHost}}/{{{gitUserId}}}/{{{gitRepoId}}}.git +``` +(you may need to run `pip` with root permission: `sudo pip install git+https://{{gitHost}}/{{{gitUserId}}}/{{{gitRepoId}}}.git`) + +Then import the package: +```python +import {{{packageName}}} +``` + +### Setuptools + +Install via [Setuptools](http://pypi.python.org/pypi/setuptools). + +```sh +python setup.py install --user +``` +(or `sudo python setup.py install` to install the package for all users) +{{/useCustomTemplateCode}} +{{#useCustomTemplateCode}} ## Migrating from legacy SDK This SDK is generated from our officially maintained [OpenAPI spec](https://github.com/hellosign/hellosign-openapi/blob/main/openapi.yaml). @@ -60,6 +101,7 @@ Alternatively: ```shell pip install git+https://github.com/hellosign/dropbox-sign-python.git ``` +{{/useCustomTemplateCode}} Then import the package: ```python diff --git a/sdks/python/templates/README_common.mustache b/sdks/python/templates/README_common.mustache index 9de12f373..21b8d378b 100644 --- a/sdks/python/templates/README_common.mustache +++ b/sdks/python/templates/README_common.mustache @@ -1,17 +1,64 @@ +{{^useCustomTemplateCode}} +```python +{{#apiInfo}}{{#apis}}{{#-last}}{{#hasHttpSignatureMethods}}import datetime{{/hasHttpSignatureMethods}}{{/-last}}{{/apis}}{{/apiInfo}} +import time +import {{{packageName}}} +from pprint import pprint +{{#apiInfo}} +{{#apis}} +{{#-first}} +from {{apiPackage}} import {{classFilename}} +{{#imports}} +{{{import}}} +{{/imports}} +{{#operations}} +{{#operation}} +{{#-first}} +{{> python_doc_auth_partial}} + +# Enter a context with an instance of the API client +with {{{packageName}}}.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = {{classFilename}}.{{{classname}}}(api_client) + {{#allParams}}{{paramName}} = {{{example}}} # {{{dataType}}} | {{{description}}}{{^required}} (optional){{/required}}{{#defaultValue}} (default to {{{.}}}){{/defaultValue}} + {{/allParams}} + + try: + {{#summary}} # {{{.}}} + {{/summary}} {{#returnType}}api_response = {{/returnType}}api_instance.{{{operationId}}}({{#allParams}}{{#required}}{{paramName}}{{/required}}{{^required}}{{paramName}}={{paramName}}{{/required}}{{^-last}}, {{/-last}}{{/allParams}}){{#returnType}} + pprint(api_response){{/returnType}} + except {{{packageName}}}.ApiException as e: + print("Exception when calling {{classname}}->{{operationId}}: %s\n" % e) +{{/-first}} +{{/operation}} +{{/operations}} +{{/-first}} +{{/apis}} +{{/apiInfo}} +``` +{{/useCustomTemplateCode}} +{{#useCustomTemplateCode}} {{#apiInfo}}{{#apis}}{{#-first}}{{#operations}}{{#operation}}{{#-first}} ```python REPLACE_ME_WITH_EXAMPLE_FOR__{{{operationId}}}_Python_CODE ``` {{/-first}}{{/operation}}{{/operations}}{{/-first}}{{/apis}}{{/apiInfo}} +{{/useCustomTemplateCode}} ## Documentation for API Endpoints All URIs are relative to *{{basePath}}* -|Class | Method | HTTP request | Description| -|------------ | ------------- | ------------- | -------------| +Class | Method | HTTP request | Description +------------ | ------------- | ------------- | ------------- +{{^useCustomTemplateCode}} +{{#apiInfo}}{{#apis}}{{#operations}}{{#operation}}*{{classname}}* | [**{{operationId}}**]({{apiDocPath}}{{classname}}.md#{{operationIdLowerCase}}) | **{{httpMethod}}** {{path}} | {{summary}} +{{/operation}}{{/operations}}{{/apis}}{{/apiInfo}} +{{/useCustomTemplateCode}} +{{#useCustomTemplateCode}} {{#apiInfo}}{{#apis}}{{#operations}}|{{#operation}}```{{classname}}``` | [```{{operationId}}```]({{apiDocPath}}{{classname}}.md#{{operationIdLowerCase}}) | ```{{httpMethod}} {{path}}``` | {{summary}}| {{/operation}}{{/operations}}{{/apis}}{{/apiInfo}} +{{/useCustomTemplateCode}} ## Documentation For Models @@ -59,6 +106,27 @@ All URIs are relative to *{{basePath}}* {{#apiInfo}}{{#apis}}{{#-last}}{{infoEmail}} {{/-last}}{{/apis}}{{/apiInfo}} +{{^useCustomTemplateCode}} +## Notes for Large OpenAPI documents +If the OpenAPI document is large, imports in {{{packageName}}}.apis and {{{packageName}}}.models may fail with a +RecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions: + +Solution 1: +Use specific imports for apis and models like: +- `from {{{packageName}}}.api.default_api import DefaultApi` +- `from {{{packageName}}}.model.pet import Pet` + +Solution 2: +Before importing the package, adjust the maximum recursion limit as shown below: +``` +import sys +sys.setrecursionlimit(1500) +import {{{packageName}}} +from {{{packageName}}}.apis import * +from {{{packageName}}}.models import * +``` +{{/useCustomTemplateCode}} +{{#useCustomTemplateCode}} ## About this package This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: @@ -72,3 +140,4 @@ This Python package is automatically generated by the [OpenAPI Generator](https: {{#infoUrl}} For more information, please visit [{{{infoUrl}}}]({{{infoUrl}}}) {{/infoUrl}} +{{/useCustomTemplateCode}} diff --git a/sdks/python/templates/__init__package.mustache b/sdks/python/templates/__init__package.mustache index ce02cd628..bb49d0c07 100644 --- a/sdks/python/templates/__init__package.mustache +++ b/sdks/python/templates/__init__package.mustache @@ -25,4 +25,6 @@ from {{packageName}}.exceptions import ApiException __import__('sys').setrecursionlimit({{{.}}}) {{/recursionLimit}} +{{#useCustomTemplateCode}} from dropbox_sign.event_callback_helper import EventCallbackHelper +{{/useCustomTemplateCode}} \ No newline at end of file diff --git a/sdks/python/templates/api.mustache b/sdks/python/templates/api.mustache index dffd9a0b0..e70c8ca1e 100644 --- a/sdks/python/templates/api.mustache +++ b/sdks/python/templates/api.mustache @@ -1,10 +1,17 @@ {{>partial_header}} +{{#useCustomTemplateCode}} from __future__ import annotations +{{/useCustomTemplateCode}} import re # noqa: F401 import sys # noqa: F401 +{{^useCustomTemplateCode}} +from {{packageName}}.api_client import ApiClient, Endpoint as _Endpoint +{{/useCustomTemplateCode}} +{{#useCustomTemplateCode}} from {{packageName}}.api_client import ApiClient, ApiException, Endpoint as _Endpoint +{{/useCustomTemplateCode}} from {{packageName}}.model_utils import ( # noqa: F401 check_allowed_values, check_validations, @@ -226,7 +233,12 @@ class {{classname}}(object): {{/defaultValue}} {{/requiredParams}} **kwargs +{{^useCustomTemplateCode}} + ): +{{/useCustomTemplateCode}} +{{#useCustomTemplateCode}} ) -> {{#returnType}}{{.}}{{/returnType}}{{^returnType}}None{{/returnType}}: +{{/useCustomTemplateCode}} """{{{summary}}}{{^summary}}{{operationId}}{{/summary}} # noqa: E501 {{#notes}} @@ -316,6 +328,10 @@ class {{classname}}(object): kwargs['{{paramName}}'] = \ {{paramName}} {{/requiredParams}} +{{^useCustomTemplateCode}} + return self.{{operationId}}_endpoint.call_with_http_info(**kwargs) +{{/useCustomTemplateCode}} +{{#useCustomTemplateCode}} {{^returnType}} return self.{{operationId}}_endpoint.call_with_http_info(**kwargs) {{/returnType}} @@ -371,6 +387,7 @@ class {{classname}}(object): {{/dataType}} {{/responses}} {{/returnType}} +{{/useCustomTemplateCode}} {{/operation}} {{/operations}} diff --git a/sdks/python/templates/api_client.mustache b/sdks/python/templates/api_client.mustache index 4891673e4..087a84a69 100644 --- a/sdks/python/templates/api_client.mustache +++ b/sdks/python/templates/api_client.mustache @@ -329,8 +329,10 @@ class ApiClient(object): # fetch data from response object try: received_data = json.loads(response.data) +{{#useCustomTemplateCode}} except TypeError: received_data = response.data +{{/useCustomTemplateCode}} except ValueError: received_data = response.data @@ -771,6 +773,10 @@ class Endpoint(object): continue if param_location: if param_location == 'body': +{{^useCustomTemplateCode}} + params['body'] = param_value +{{/useCustomTemplateCode}} +{{#useCustomTemplateCode}} """We want to support a single typed object parameter for all endpoints, including of multipart/form-data content-types. """ @@ -809,6 +815,7 @@ class Endpoint(object): params['form'].append(param_value_full) else: params['body'] = param_value +{{/useCustomTemplateCode}} continue base_name = self.attribute_map[param_name] if (param_location == 'form' and @@ -891,6 +898,7 @@ class Endpoint(object): params = self.__gather_params(kwargs) +{{#useCustomTemplateCode}} # Remove None values from query parameters query_to_keep = [] for key, value in params['query']: @@ -899,6 +907,7 @@ class Endpoint(object): params['query'] = query_to_keep +{{/useCustomTemplateCode}} accept_headers_list = self.headers_map['accept'] if accept_headers_list: params['header']['Accept'] = self.api_client.select_header_accept( @@ -909,9 +918,14 @@ class Endpoint(object): else: content_type_headers_list = self.headers_map['content_type'] if content_type_headers_list: +{{^useCustomTemplateCode}} + if params['body'] != "": +{{/useCustomTemplateCode}} +{{#useCustomTemplateCode}} if len(params['form']) > 0 or ('file' in params.keys() and len(params['file']) > 0): params['header']['Content-Type'] = 'multipart/form-data' elif params['body'] != "": +{{/useCustomTemplateCode}} header_list = self.api_client.select_header_content_type( content_type_headers_list, self.settings['http_method'], params['body']) diff --git a/sdks/python/templates/api_doc.mustache b/sdks/python/templates/api_doc.mustache index 7e690ca1f..afe8e68d1 100644 --- a/sdks/python/templates/api_doc.mustache +++ b/sdks/python/templates/api_doc.mustache @@ -1,17 +1,35 @@ +{{^useCustomTemplateCode}} +# {{packageName}}.{{classname}}{{#description}} +{{.}}{{/description}} +{{/useCustomTemplateCode}} +{{#useCustomTemplateCode}} # ```{{packageName}}.{{classname}}```{{#description}} {{.}}{{/description}} +{{/useCustomTemplateCode}} All URIs are relative to *{{basePath}}* -|Method | HTTP request | Description| -|------------- | ------------- | -------------| +Method | HTTP request | Description +------------- | ------------- | ------------- +{{^useCustomTemplateCode}} +{{#operations}}{{#operation}}[**{{operationId}}**]({{classname}}.md#{{operationId}}) | **{{httpMethod}}** {{path}} | {{summary}} +{{/operation}}{{/operations}} +{{/useCustomTemplateCode}} +{{#useCustomTemplateCode}} {{#operations}}{{#operation}}|[```{{operationId}}```]({{classname}}.md#{{operationId}}) | ```{{httpMethod}} {{path}}``` | {{summary}}| {{/operation}}{{/operations}} +{{/useCustomTemplateCode}} {{#operations}} {{#operation}} +{{^useCustomTemplateCode}} +# **{{{operationId}}}** +> {{#returnType}}{{{.}}} {{/returnType}}{{{operationId}}}({{#requiredParams}}{{^defaultValue}}{{paramName}}{{^-last}}, {{/-last}}{{/defaultValue}}{{/requiredParams}}) +{{/useCustomTemplateCode}} +{{#useCustomTemplateCode}} # ```{{{operationId}}}``` > ```{{#returnType}}{{{.}}} {{/returnType}}{{{operationId}}}({{#requiredParams}}{{^defaultValue}}{{paramName}}{{^-last}}, {{/-last}}{{/defaultValue}}{{/requiredParams}})``` +{{/useCustomTemplateCode}} {{{summary}}}{{#notes}} @@ -41,7 +59,16 @@ All URIs are relative to *{{basePath}}* {{> api_doc_example }} ### Parameters - +{{^useCustomTemplateCode}} +{{^allParams}}This endpoint does not need any parameter.{{/allParams}}{{#allParams}}{{#-last}} +Name | Type | Description | Notes +------------- | ------------- | ------------- | -------------{{/-last}}{{/allParams}} +{{#requiredParams}}{{^defaultValue}} **{{paramName}}** | {{^baseType}}**{{dataType}}**{{/baseType}}{{#baseType}}[**{{dataType}}**]({{baseType}}.md){{/baseType}}| {{description}} | +{{/defaultValue}}{{/requiredParams}}{{#requiredParams}}{{#defaultValue}} **{{paramName}}** | {{^baseType}}**{{dataType}}**{{/baseType}}{{#baseType}}[**{{dataType}}**]({{baseType}}.md){{/baseType}}| {{description}} | defaults to {{{.}}} +{{/defaultValue}}{{/requiredParams}}{{#optionalParams}} **{{paramName}}** | {{^baseType}}**{{dataType}}**{{/baseType}}{{#baseType}}[**{{dataType}}**]({{baseType}}.md){{/baseType}}| {{description}} | [optional]{{#defaultValue}} if omitted the server will use the default value of {{{.}}}{{/defaultValue}} +{{/optionalParams}} +{{/useCustomTemplateCode}} +{{#useCustomTemplateCode}} {{^allParams}} This endpoint does not need any parameter. {{/allParams}} @@ -52,6 +79,7 @@ This endpoint does not need any parameter. {{/-first}} | `{{paramName}}` | {{#isPrimitiveType}}**{{dataType}}**{{/isPrimitiveType}}{{^isPrimitiveType}}{{#isFile}}**{{dataType}}**{{/isFile}}{{^isFile}}[**{{dataType}}**]({{baseType}}.md){{/isFile}}{{/isPrimitiveType}} | {{description}} | {{^required}}[optional]{{/required}}{{#defaultValue}}[default to {{.}}]{{/defaultValue}} | {{/allParams}} +{{/useCustomTemplateCode}} ### Return type diff --git a/sdks/python/templates/api_doc_example.mustache b/sdks/python/templates/api_doc_example.mustache index 587840326..04b812687 100644 --- a/sdks/python/templates/api_doc_example.mustache +++ b/sdks/python/templates/api_doc_example.mustache @@ -1,3 +1,81 @@ ```python +{{^useCustomTemplateCode}} +import time +import {{{packageName}}} +from {{apiPackage}} import {{classFilename}} +{{#imports}} +{{{.}}} +{{/imports}} +from pprint import pprint +{{> python_doc_auth_partial}} +# Enter a context with an instance of the API client +{{#hasAuthMethods}} +with {{{packageName}}}.ApiClient(configuration) as api_client: +{{/hasAuthMethods}} +{{^hasAuthMethods}} +with {{{packageName}}}.ApiClient() as api_client: +{{/hasAuthMethods}} + # Create an instance of the API class + api_instance = {{classFilename}}.{{{classname}}}(api_client) +{{#requiredParams}} +{{^defaultValue}} + {{paramName}} = {{{example}}} # {{{dataType}}} | {{{description}}} +{{/defaultValue}} +{{/requiredParams}} +{{#optionalParams}} + {{paramName}} = {{{example}}} # {{{dataType}}} | {{{description}}}{{^required}} (optional){{/required}}{{#defaultValue}} if omitted the server will use the default value of {{{.}}}{{/defaultValue}} +{{/optionalParams}} +{{#requiredParams}} +{{#-last}} + + # example passing only required values which don't have defaults set + try: +{{#summary}} + # {{{.}}} +{{/summary}} + {{#returnType}}api_response = {{/returnType}}api_instance.{{{operationId}}}({{#requiredParams}}{{^defaultValue}}{{paramName}}{{^-last}}, {{/-last}}{{/defaultValue}}{{/requiredParams}}) +{{#returnType}} + pprint(api_response) +{{/returnType}} + except {{{packageName}}}.ApiException as e: + print("Exception when calling {{classname}}->{{operationId}}: %s\n" % e) +{{/-last}} +{{/requiredParams}} +{{#optionalParams}} +{{#-last}} + + # example passing only required values which don't have defaults set + # and optional values + try: +{{#summary}} + # {{{.}}} +{{/summary}} + {{#returnType}}api_response = {{/returnType}}api_instance.{{{operationId}}}({{#requiredParams}}{{^defaultValue}}{{paramName}}, {{/defaultValue}}{{/requiredParams}}{{#optionalParams}}{{paramName}}={{paramName}}{{^-last}}, {{/-last}}{{/optionalParams}}) +{{#returnType}} + pprint(api_response) +{{/returnType}} + except {{{packageName}}}.ApiException as e: + print("Exception when calling {{classname}}->{{operationId}}: %s\n" % e) +{{/-last}} +{{/optionalParams}} +{{^requiredParams}} +{{^optionalParams}} + + # example, this endpoint has no required or optional parameters + try: +{{#summary}} + # {{{.}}} +{{/summary}} + {{#returnType}}api_response = {{/returnType}}api_instance.{{{operationId}}}() +{{#returnType}} + pprint(api_response) +{{/returnType}} + except {{{packageName}}}.ApiException as e: + print("Exception when calling {{classname}}->{{operationId}}: %s\n" % e) +{{/optionalParams}} +{{/requiredParams}} +{{/useCustomTemplateCode}} +{{#useCustomTemplateCode}} REPLACE_ME_WITH_EXAMPLE_FOR__{{{operationId}}}_Python_CODE +{{/useCustomTemplateCode}} ``` diff --git a/sdks/python/templates/configuration.mustache b/sdks/python/templates/configuration.mustache index 150aff3b4..1d518a715 100644 --- a/sdks/python/templates/configuration.mustache +++ b/sdks/python/templates/configuration.mustache @@ -489,7 +489,12 @@ conf = {{{packageName}}}.Configuration( {{/isApiKey}} {{#isBasic}} {{#isBasicBasic}} +{{^useCustomTemplateCode}} + if self.username is not None and self.password is not None: +{{/useCustomTemplateCode}} +{{#useCustomTemplateCode}} if self.username is not None or self.password is not None: +{{/useCustomTemplateCode}} auth['{{name}}'] = { 'type': 'basic', 'in': 'header', diff --git a/sdks/python/templates/gitignore.mustache b/sdks/python/templates/gitignore.mustache index 491b7085b..e0dc5325d 100644 --- a/sdks/python/templates/gitignore.mustache +++ b/sdks/python/templates/gitignore.mustache @@ -65,4 +65,6 @@ target/ #Ipython Notebook .ipynb_checkpoints +{{#useCustomTemplateCode}} /vendor +{{/useCustomTemplateCode}} \ No newline at end of file diff --git a/sdks/python/templates/model.mustache b/sdks/python/templates/model.mustache index e6705eb48..14d8e5e49 100644 --- a/sdks/python/templates/model.mustache +++ b/sdks/python/templates/model.mustache @@ -1,12 +1,15 @@ {{> partial_header }} +{{#useCustomTemplateCode}} from __future__ import annotations from typing import TYPE_CHECKING, Optional, List, Dict, Union import json # noqa: F401 +{{/useCustomTemplateCode}} import re # noqa: F401 import sys # noqa: F401 - +{{#useCustomTemplateCode}} from {{packageName}} import ApiClient +{{/useCustomTemplateCode}} from {{packageName}}.model_utils import ( # noqa: F401 ApiTypeError, ModelComposed, @@ -23,15 +26,18 @@ from {{packageName}}.model_utils import ( # noqa: F401 OpenApiModel ) from {{packageName}}.exceptions import ApiAttributeError +{{#useCustomTemplateCode}} {{#imports}} {{#-first}} if TYPE_CHECKING: {{/-first}} {{{import}}} {{/imports}} +{{/useCustomTemplateCode}} {{#models}} {{#model}} +{{#useCustomTemplateCode}} {{#discriminator}} {{#-first}} if TYPE_CHECKING: @@ -51,6 +57,7 @@ def lazy_import(): globals()['{{modelName}}'] = {{modelName}} {{/discriminator.mappedModels}} {{/discriminator}} +{{/useCustomTemplateCode}} {{#imports}} {{#-first}} @@ -84,4 +91,4 @@ def lazy_import(): {{/-last}} {{/interfaces}} {{/model}} -{{/models}} \ No newline at end of file +{{/models}} diff --git a/sdks/python/templates/model_doc.mustache b/sdks/python/templates/model_doc.mustache index b81c150bd..f9060e9f6 100644 --- a/sdks/python/templates/model_doc.mustache +++ b/sdks/python/templates/model_doc.mustache @@ -1,14 +1,47 @@ {{#models}}{{#model}}# {{classname}} +{{^useCustomTemplateCode}} +{{#description}}{{&description}} +{{/description}} +{{/useCustomTemplateCode}} +{{#useCustomTemplateCode}} {{unescapedDescription}} +{{/useCustomTemplateCode}} ## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +{{^useCustomTemplateCode}} +{{#isEnum}} +**value** | {{^arrayModelType}}**{{dataType}}**{{/arrayModelType}} | {{description}} | {{#defaultValue}}{{#hasRequired}} if omitted the server will use the default value of {{/hasRequired}}{{^hasRequired}}defaults to {{/hasRequired}}{{{.}}}{{/defaultValue}}{{#allowableValues}}{{#defaultValue}}, {{/defaultValue}} must be one of [{{#enumVars}}{{{value}}}, {{/enumVars}}]{{/allowableValues}} +{{/isEnum}} +{{#isAlias}} +**value** | {{^arrayModelType}}**{{dataType}}**{{/arrayModelType}} | {{description}} | {{#defaultValue}}{{#hasRequired}} if omitted the server will use the default value of {{/hasRequired}}{{^hasRequired}}defaults to {{/hasRequired}}{{{.}}}{{/defaultValue}} +{{/isAlias}} +{{#isArray}} +**value** | {{^arrayModelType}}**{{dataType}}**{{/arrayModelType}}{{#arrayModelType}}[**{{dataType}}**]({{arrayModelType}}.md){{/arrayModelType}} | {{description}} | {{#defaultValue}}{{#hasRequired}} if omitted the server will use the default value of {{/hasRequired}}{{^hasRequired}}defaults to {{/hasRequired}}{{{.}}}{{/defaultValue}} +{{/isArray}} +{{#requiredVars}} +{{^defaultValue}} +**{{name}}** | {{^complexType}}**{{dataType}}**{{/complexType}}{{#complexType}}[**{{dataType}}**]({{complexType}}.md){{/complexType}} | {{description}} | {{#isReadOnly}}[readonly] {{/isReadOnly}} +{{/defaultValue}} +{{/requiredVars}} +{{#requiredVars}} +{{#defaultValue}} +**{{name}}** | {{^complexType}}**{{dataType}}**{{/complexType}}{{#complexType}}[**{{dataType}}**]({{complexType}}.md){{/complexType}} | {{description}} | {{^required}}[optional] {{/required}}{{#isReadOnly}}[readonly] {{/isReadOnly}}{{#defaultValue}}defaults to {{{.}}}{{/defaultValue}} +{{/defaultValue}} +{{/requiredVars}} +{{#optionalVars}} +**{{name}}** | {{^complexType}}**{{dataType}}**{{/complexType}}{{#complexType}}[**{{dataType}}**]({{complexType}}.md){{/complexType}} | {{description}} | [optional] {{#isReadOnly}}[readonly] {{/isReadOnly}}{{#defaultValue}} if omitted the server will use the default value of {{{.}}}{{/defaultValue}} +{{/optionalVars}} +{{#additionalProperties}} +**any string name** | {{^complexType}}**{{dataType}}**{{/complexType}}{{#complexType}}[**{{dataType}}**]({{complexType}}.md){{/complexType}} | any string name can be used but the value must be the correct type | [optional] +{{/additionalProperties}} +{{/useCustomTemplateCode}} +{{#useCustomTemplateCode}} {{#vars}}| `{{name}}`{{#required}}*_required_{{/required}} | {{#isPrimitiveType}}```{{{dataType}}}```{{/isPrimitiveType}}{{^isPrimitiveType}}[```{{{dataType}}}```]({{complexType}}.md){{/isPrimitiveType}} | REPLACE_ME_WITH_DESCRIPTION_BEGIN {{unescapedDescription}} REPLACE_ME_WITH_DESCRIPTION_END | {{#isReadOnly}} [readonly]{{/isReadOnly}}{{#defaultValue}} [default to {{{.}}}]{{/defaultValue}} | {{/vars}} - +{{/useCustomTemplateCode}} [[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/sdks/python/templates/model_templates/classvars.mustache b/sdks/python/templates/model_templates/classvars.mustache index e22c33e58..c6d24167d 100644 --- a/sdks/python/templates/model_templates/classvars.mustache +++ b/sdks/python/templates/model_templates/classvars.mustache @@ -67,11 +67,13 @@ This must be a method because a model may have properties that are of type self, this must run after the class is loaded """ +{{#useCustomTemplateCode}} {{#discriminator}} {{^imports}} lazy_import() {{/imports}} {{/discriminator}} +{{/useCustomTemplateCode}} {{#imports}} {{#-first}} lazy_import() @@ -95,11 +97,13 @@ openapi_types (dict): The key is attribute name and the value is attribute type. """ +{{#useCustomTemplateCode}} {{#discriminator}} {{^imports}} lazy_import() {{/imports}} {{/discriminator}} +{{/useCustomTemplateCode}} {{#imports}} {{#-first}} lazy_import() @@ -107,19 +111,44 @@ {{/imports}} return { {{#isAlias}} +{{^useCustomTemplateCode}} + 'value': ({{{dataType}}},), +{{/useCustomTemplateCode}} +{{#useCustomTemplateCode}} 'value': ({{#vendorExtensions.x-int-or-string}}int, str{{/vendorExtensions.x-int-or-string}}{{^vendorExtensions.x-int-or-string}}{{{dataType}}}{{/vendorExtensions.x-int-or-string}},), +{{/useCustomTemplateCode}} {{/isAlias}} {{#isEnum}} +{{^useCustomTemplateCode}} + 'value': ({{{dataType}}},), +{{/useCustomTemplateCode}} +{{#useCustomTemplateCode}} 'value': ({{#vendorExtensions.x-int-or-string}}int, str{{/vendorExtensions.x-int-or-string}}{{^vendorExtensions.x-int-or-string}}{{{dataType}}}{{/vendorExtensions.x-int-or-string}},), +{{/useCustomTemplateCode}} {{/isEnum}} {{#isArray}} +{{^useCustomTemplateCode}} + 'value': ({{{dataType}}},), +{{/useCustomTemplateCode}} +{{#useCustomTemplateCode}} 'value': ({{#vendorExtensions.x-int-or-string}}int, str{{/vendorExtensions.x-int-or-string}}{{^vendorExtensions.x-int-or-string}}{{{dataType}}}{{/vendorExtensions.x-int-or-string}},), +{{/useCustomTemplateCode}} {{/isArray}} {{#requiredVars}} +{{^useCustomTemplateCode}} + '{{name}}': ({{{dataType}}},), # noqa: E501 +{{/useCustomTemplateCode}} +{{#useCustomTemplateCode}} '{{name}}': ({{#vendorExtensions.x-int-or-string}}int, str{{/vendorExtensions.x-int-or-string}}{{^vendorExtensions.x-int-or-string}}{{{dataType}}}{{/vendorExtensions.x-int-or-string}},), # noqa: E501 +{{/useCustomTemplateCode}} {{/requiredVars}} {{#optionalVars}} +{{^useCustomTemplateCode}} + '{{name}}': ({{{dataType}}},), # noqa: E501 +{{/useCustomTemplateCode}} +{{#useCustomTemplateCode}} '{{name}}': ({{#vendorExtensions.x-int-or-string}}int, str{{/vendorExtensions.x-int-or-string}}{{^vendorExtensions.x-int-or-string}}{{{dataType}}}{{/vendorExtensions.x-int-or-string}},), # noqa: E501 +{{/useCustomTemplateCode}} {{/optionalVars}} } @@ -129,7 +158,20 @@ return None {{/discriminator}} {{#discriminator}} +{{^useCustomTemplateCode}} +{{#mappedModels}} +{{#-first}} +{{#imports}} +{{#-first}} + lazy_import() +{{/-first}} +{{/imports}} +{{/-first}} +{{/mappedModels}} +{{/useCustomTemplateCode}} +{{#useCustomTemplateCode}} lazy_import() +{{/useCustomTemplateCode}} val = { {{#mappedModels}} '{{mappingName}}': {{{modelName}}}, @@ -138,6 +180,7 @@ if not val: return None return {'{{{discriminatorName}}}': val}{{/discriminator}} +{{#useCustomTemplateCode}} {{^discriminator}} @staticmethod def init(data: any) -> {{classname}}: @@ -155,3 +198,4 @@ _check_type=True, ) {{/discriminator}} +{{/useCustomTemplateCode}} \ No newline at end of file diff --git a/sdks/python/templates/model_templates/docstring_init_required_kwargs.mustache b/sdks/python/templates/model_templates/docstring_init_required_kwargs.mustache index a9abdf18b..70d2f95dc 100644 --- a/sdks/python/templates/model_templates/docstring_init_required_kwargs.mustache +++ b/sdks/python/templates/model_templates/docstring_init_required_kwargs.mustache @@ -22,7 +22,12 @@ 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 +{{^useCustomTemplateCode}} + allOf includes Animal, we move through Animal +{{/useCustomTemplateCode}} +{{#useCustomTemplateCode}} includes Animal, we move through Animal +{{/useCustomTemplateCode}} 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 diff --git a/sdks/python/templates/model_templates/method_from_openapi_data_composed.mustache b/sdks/python/templates/model_templates/method_from_openapi_data_composed.mustache index ad21665c3..7f7bb55aa 100644 --- a/sdks/python/templates/model_templates/method_from_openapi_data_composed.mustache +++ b/sdks/python/templates/model_templates/method_from_openapi_data_composed.mustache @@ -6,15 +6,30 @@ Keyword Args: {{#requiredVars}} {{#defaultValue}} +{{^useCustomTemplateCode}} + {{name}} ({{{dataType}}}):{{#description}} {{{.}}}.{{/description}} defaults to {{{defaultValue}}}{{#allowableValues}}, must be one of [{{#enumVars}}{{{value}}}, {{/enumVars}}]{{/allowableValues}} # noqa: E501 +{{/useCustomTemplateCode}} +{{#useCustomTemplateCode}} {{name}} ({{#vendorExtensions.x-int-or-string}}str|int{{/vendorExtensions.x-int-or-string}}{{^vendorExtensions.x-int-or-string}}{{{dataType}}}{{/vendorExtensions.x-int-or-string}}):{{#description}} {{{.}}}.{{/description}} defaults to {{{defaultValue}}}{{#allowableValues}}, must be one of [{{#enumVars}}{{{value}}}, {{/enumVars}}]{{/allowableValues}} # noqa: E501 +{{/useCustomTemplateCode}} {{/defaultValue}} {{^defaultValue}} +{{^useCustomTemplateCode}} + {{name}} ({{{dataType}}}):{{#description}} {{{.}}}{{/description}} +{{/useCustomTemplateCode}} +{{#useCustomTemplateCode}} {{name}} ({{#vendorExtensions.x-int-or-string}}str|int{{/vendorExtensions.x-int-or-string}}{{^vendorExtensions.x-int-or-string}}{{{dataType}}}{{/vendorExtensions.x-int-or-string}}):{{#description}} {{{.}}}{{/description}} +{{/useCustomTemplateCode}} {{/defaultValue}} {{/requiredVars}} {{> model_templates/docstring_init_required_kwargs }} {{#optionalVars}} +{{^useCustomTemplateCode}} + {{name}} ({{{dataType}}}):{{#description}} {{{.}}}.{{/description}} [optional]{{#defaultValue}} if omitted the server will use the default value of {{{.}}}{{/defaultValue}} # noqa: E501 +{{/useCustomTemplateCode}} +{{#useCustomTemplateCode}} {{name}} ({{#vendorExtensions.x-int-or-string}}str|int{{/vendorExtensions.x-int-or-string}}{{^vendorExtensions.x-int-or-string}}{{{dataType}}}{{/vendorExtensions.x-int-or-string}}):{{#description}} {{{.}}}.{{/description}} [optional]{{#defaultValue}} if omitted the server will use the default value of {{{.}}}{{/defaultValue}} # noqa: E501 +{{/useCustomTemplateCode}} {{/optionalVars}} """ diff --git a/sdks/python/templates/model_templates/method_from_openapi_data_shared.mustache b/sdks/python/templates/model_templates/method_from_openapi_data_shared.mustache index 4b9335fcb..87ee989b6 100644 --- a/sdks/python/templates/model_templates/method_from_openapi_data_shared.mustache +++ b/sdks/python/templates/model_templates/method_from_openapi_data_shared.mustache @@ -8,7 +8,12 @@ Args: {{/-first}} {{^defaultValue}} +{{^useCustomTemplateCode}} + {{name}} ({{{dataType}}}):{{#description}} {{{.}}}{{/description}} +{{/useCustomTemplateCode}} +{{#useCustomTemplateCode}} {{name}} ({{#vendorExtensions.x-int-or-string}}str|int{{/vendorExtensions.x-int-or-string}}{{^vendorExtensions.x-int-or-string}}{{{dataType}}}{{/vendorExtensions.x-int-or-string}}):{{#description}} {{{.}}}{{/description}} +{{/useCustomTemplateCode}} {{/defaultValue}} {{#-last}} diff --git a/sdks/python/templates/model_templates/method_init_composed.mustache b/sdks/python/templates/model_templates/method_init_composed.mustache index 15d83c925..a0203e9c2 100644 --- a/sdks/python/templates/model_templates/method_init_composed.mustache +++ b/sdks/python/templates/model_templates/method_init_composed.mustache @@ -18,16 +18,31 @@ {{#requiredVars}} {{^isReadOnly}} {{#defaultValue}} +{{^useCustomTemplateCode}} + {{name}} ({{{dataType}}}):{{#description}} {{{.}}}.{{/description}} defaults to {{{defaultValue}}}{{#allowableValues}}, must be one of [{{#enumVars}}{{{value}}}, {{/enumVars}}]{{/allowableValues}} # noqa: E501 +{{/useCustomTemplateCode}} +{{#useCustomTemplateCode}} {{name}} ({{#vendorExtensions.x-int-or-string}}str|int{{/vendorExtensions.x-int-or-string}}{{^vendorExtensions.x-int-or-string}}{{{dataType}}}{{/vendorExtensions.x-int-or-string}}):{{#description}} {{{.}}}.{{/description}} defaults to {{{defaultValue}}}{{#allowableValues}}, must be one of [{{#enumVars}}{{{value}}}, {{/enumVars}}]{{/allowableValues}} # noqa: E501 +{{/useCustomTemplateCode}} {{/defaultValue}} {{^defaultValue}} +{{^useCustomTemplateCode}} + {{name}} ({{{dataType}}}):{{#description}} {{{.}}}{{/description}} +{{/useCustomTemplateCode}} +{{#useCustomTemplateCode}} {{name}} ({{#vendorExtensions.x-int-or-string}}str|int{{/vendorExtensions.x-int-or-string}}{{^vendorExtensions.x-int-or-string}}{{{dataType}}}{{/vendorExtensions.x-int-or-string}}):{{#description}} {{{.}}}{{/description}} +{{/useCustomTemplateCode}} {{/defaultValue}} {{/isReadOnly}} {{/requiredVars}} {{> model_templates/docstring_init_required_kwargs }} {{#optionalVars}} +{{^useCustomTemplateCode}} + {{name}} ({{{dataType}}}):{{#description}} {{{.}}}.{{/description}} [optional]{{#defaultValue}} if omitted the server will use the default value of {{{.}}}{{/defaultValue}} # noqa: E501 +{{/useCustomTemplateCode}} +{{#useCustomTemplateCode}} {{name}} ({{#vendorExtensions.x-int-or-string}}str|int{{/vendorExtensions.x-int-or-string}}{{^vendorExtensions.x-int-or-string}}{{{dataType}}}{{/vendorExtensions.x-int-or-string}}):{{#description}} {{{.}}}.{{/description}} [optional]{{#defaultValue}} if omitted the server will use the default value of {{{.}}}{{/defaultValue}} # noqa: E501 +{{/useCustomTemplateCode}} {{/optionalVars}} """ diff --git a/sdks/python/templates/model_templates/method_init_shared.mustache b/sdks/python/templates/model_templates/method_init_shared.mustache index 9debb409a..2ec2805a2 100644 --- a/sdks/python/templates/model_templates/method_init_shared.mustache +++ b/sdks/python/templates/model_templates/method_init_shared.mustache @@ -8,7 +8,12 @@ Args: {{/-first}} {{^defaultValue}} +{{^useCustomTemplateCode}} + {{name}} ({{{dataType}}}):{{#description}} {{{.}}}{{/description}} +{{/useCustomTemplateCode}} +{{#useCustomTemplateCode}} {{name}} ({{#vendorExtensions.x-int-or-string}}str|int{{/vendorExtensions.x-int-or-string}}{{^vendorExtensions.x-int-or-string}}{{{dataType}}}{{/vendorExtensions.x-int-or-string}}):{{#description}} {{{.}}}{{/description}} +{{/useCustomTemplateCode}} {{/defaultValue}} {{#-last}} diff --git a/sdks/python/templates/model_templates/methods_setattr_getattr_normal.mustache b/sdks/python/templates/model_templates/methods_setattr_getattr_normal.mustache index 9540c194d..d260d7371 100644 --- a/sdks/python/templates/model_templates/methods_setattr_getattr_normal.mustache +++ b/sdks/python/templates/model_templates/methods_setattr_getattr_normal.mustache @@ -18,7 +18,16 @@ if name in self: return self.get(name) +{{^useCustomTemplateCode}} + raise ApiAttributeError( + "{0} has no attribute '{1}'".format( + type(self).__name__, name), + [e for e in [self._path_to_item, name] if e] + ) +{{/useCustomTemplateCode}} +{{#useCustomTemplateCode}} return None +{{/useCustomTemplateCode}} def __contains__(self, name): """used by `in` operator to check if an attribute value was set in an instance: `'attr' in instance`""" diff --git a/sdks/python/templates/model_templates/model_composed.mustache b/sdks/python/templates/model_templates/model_composed.mustache index 92c528d35..9f8d0ee63 100644 --- a/sdks/python/templates/model_templates/model_composed.mustache +++ b/sdks/python/templates/model_templates/model_composed.mustache @@ -36,6 +36,7 @@ class {{classname}}(ModelComposed): {{/isReadOnly}} {{/optionalVars}} } +{{#useCustomTemplateCode}} {{#requiredVars}} @property @@ -58,6 +59,7 @@ class {{classname}}(ModelComposed): def {{name}}(self, value: {{{dataType}}}): setattr(self, "{{name}}", value) {{/optionalVars}} +{{/useCustomTemplateCode}} {{> model_templates/method_from_openapi_data_composed }} @@ -83,6 +85,13 @@ class {{classname}}(ModelComposed): {{{.}}}, {{/anyOf}} ], +{{^useCustomTemplateCode}} + 'allOf': [ +{{#allOf}} + {{{.}}}, +{{/allOf}} + ], +{{/useCustomTemplateCode}} 'oneOf': [ {{#oneOf}} {{{.}}}, diff --git a/sdks/python/templates/model_templates/model_normal.mustache b/sdks/python/templates/model_templates/model_normal.mustache index e1e0ca3f3..d62e48ca1 100644 --- a/sdks/python/templates/model_templates/model_normal.mustache +++ b/sdks/python/templates/model_templates/model_normal.mustache @@ -14,6 +14,7 @@ class {{classname}}(ModelNormal): """ {{> model_templates/classvars }} + attribute_map = { {{#requiredVars}} '{{name}}': '{{baseName}}', # noqa: E501 @@ -37,6 +38,7 @@ class {{classname}}(ModelNormal): } _composed_schemas = {} +{{#useCustomTemplateCode}} {{#requiredVars}} @property @@ -59,6 +61,7 @@ class {{classname}}(ModelNormal): def {{name}}(self, value: {{{dataType}}}): setattr(self, "{{name}}", value) {{/optionalVars}} +{{/useCustomTemplateCode}} {{> model_templates/method_from_openapi_data_normal}} diff --git a/sdks/python/templates/model_utils.mustache b/sdks/python/templates/model_utils.mustache index c92ed1910..a785cc468 100644 --- a/sdks/python/templates/model_utils.mustache +++ b/sdks/python/templates/model_utils.mustache @@ -146,7 +146,12 @@ class OpenApiModel(object): # # Here's an example of use case 2: If Animal has a discriminator # petType and we pass in "Dog", and the class Dog +{{^useCustomTemplateCode}} + # allOf includes Animal, we move through Animal +{{/useCustomTemplateCode}} +{{#useCustomTemplateCode}} # includes Animal, we move through Animal +{{/useCustomTemplateCode}} # once using the discriminator, and pick Dog. # Then in the composed schema dog Dog, we will make an instance of the # Animal class (because Dal has allOf: Animal) but this time we won't travel @@ -267,7 +272,12 @@ class OpenApiModel(object): # # Here's an example of use case 2: If Animal has a discriminator # petType and we pass in "Dog", and the class Dog +{{^useCustomTemplateCode}} + # allOf includes Animal, we move through Animal +{{/useCustomTemplateCode}} +{{#useCustomTemplateCode}} # includes Animal, we move through Animal +{{/useCustomTemplateCode}} # once using the discriminator, and pick Dog. # Then in the composed schema dog Dog, we will make an instance of the # Animal class (because Dal has allOf: Animal) but this time we won't travel @@ -794,10 +804,11 @@ def remove_uncoercible(required_types_classes, current_item, spec_property_namin elif issubclass(required_type_class_simplified, ModelSimple): required_type_class_simplified = ModelSimple +{{#useCustomTemplateCode}} # leave ints as-is if type(current_item) is int and required_type_class_simplified == current_type_simple: results_classes.append(int) - +{{/useCustomTemplateCode}} if required_type_class_simplified == current_type_simple: # don't consider converting to one's own class continue @@ -807,13 +818,14 @@ def remove_uncoercible(required_types_classes, current_item, spec_property_namin results_classes.append(required_type_class) elif class_pair in UPCONVERSION_TYPE_PAIRS: results_classes.append(required_type_class) - +{{#useCustomTemplateCode}} # allow casting int to string if type(current_item) is int: results_classes.append(str) if type(current_item) is none_type: results_classes.append(none_type) +{{/useCustomTemplateCode}} return results_classes def get_discriminated_classes(cls): @@ -959,9 +971,11 @@ def deserialize_primitive(data, klass, path_to_item): if len(data) < 8: raise ValueError("This is not a date") return parse(data).date() +{{#useCustomTemplateCode}} elif data is None: # This SDK does not support nullable params unless they are explicitly marked as nullable return data +{{/useCustomTemplateCode}} else: converted_value = klass(data) if isinstance(data, str) and klass == float: @@ -1139,9 +1153,10 @@ def attempt_convert_item(input_value, valid_classes, path_to_item, valid_classes_coercible = remove_uncoercible( valid_classes_ordered, input_value, spec_property_naming) if not valid_classes_coercible or key_type: +{{#useCustomTemplateCode}} if input_value is None: return input_value - +{{/useCustomTemplateCode}} # we do not handle keytype errors, json will take care # of this for us if configuration is None or not configuration.discard_unknown_keys: @@ -1376,7 +1391,41 @@ def model_to_dict(model_instance, serialize=True): seen_json_attribute_names.add(attr) except KeyError: used_fallback_python_attribute_names.add(attr) +{{^useCustomTemplateCode}} + if isinstance(value, list): + if not value: + # empty list or None + result[attr] = value + else: + res = [] + for v in value: + if isinstance(v, PRIMITIVE_TYPES) or v is None: + res.append(v) + elif isinstance(v, ModelSimple): + res.append(v.value) + elif isinstance(v, dict): + res.append(dict(map( + extract_item, + v.items() + ))) + else: + res.append(model_to_dict(v, serialize=serialize)) + result[attr] = res + elif isinstance(value, dict): + result[attr] = dict(map( + extract_item, + value.items() + )) + elif isinstance(value, ModelSimple): + result[attr] = value.value + elif hasattr(value, '_data_store'): + result[attr] = model_to_dict(value, serialize=serialize) + else: + result[attr] = value +{{/useCustomTemplateCode}} +{{#useCustomTemplateCode}} result[attr] = model_to_dict_recursive(value, serialize, extract_item) +{{/useCustomTemplateCode}} if serialize: for python_key in used_fallback_python_attribute_names: json_key = py_to_json_map.get(python_key) @@ -1390,7 +1439,7 @@ def model_to_dict(model_instance, serialize=True): return result - +{{#useCustomTemplateCode}} def model_to_dict_recursive(value, serialize, extract_item): if isinstance(value, list): res = [] @@ -1413,6 +1462,7 @@ def model_to_dict_recursive(value, serialize, extract_item): else: return value +{{/useCustomTemplateCode}} def type_error_message(var_value=None, var_name=None, valid_classes=None, key_type=None): @@ -1471,6 +1521,28 @@ def get_allof_instances(self, model_args, constant_args): composed_instances (list) """ composed_instances = [] +{{^useCustomTemplateCode}} + for allof_class in self._composed_schemas['allOf']: + + try: + if constant_args.get('_spec_property_naming'): + allof_instance = allof_class._from_openapi_data(**model_args, **constant_args) + else: + allof_instance = allof_class(**model_args, **constant_args) + composed_instances.append(allof_instance) + except Exception as ex: + raise ApiValueError( + "Invalid inputs given to generate an instance of '%s'. The " + "input data was invalid for the allOf schema '%s' in the composed " + "schema '%s'. Error=%s" % ( + allof_class.__name__, + allof_class.__name__, + self.__class__.__name__, + str(ex) + ) + ) from ex +{{/useCustomTemplateCode}} +{{#useCustomTemplateCode}} if 'allOf' in self._composed_schemas.keys(): for allof_class in self._composed_schemas['allOf']: @@ -1491,6 +1563,7 @@ def get_allof_instances(self, model_args, constant_args): str(ex) ) ) from ex +{{/useCustomTemplateCode}} return composed_instances @@ -1729,4 +1802,4 @@ def validate_get_composed_info(constant_args, model_args, self): var_name_to_model_instances, additional_properties_model_instances, discarded_args - ] \ No newline at end of file + ] diff --git a/sdks/python/templates/rest.mustache b/sdks/python/templates/rest.mustache index a66740247..d4293e70d 100644 --- a/sdks/python/templates/rest.mustache +++ b/sdks/python/templates/rest.mustache @@ -27,11 +27,11 @@ class RESTResponse(io.IOBase): def getheaders(self): """Returns a dictionary of the response headers.""" - return self.urllib3_response.headers + return self.urllib3_response.getheaders() def getheader(self, name, default=None): """Returns a given response header.""" - return self.urllib3_response.headers.get(name, default) + return self.urllib3_response.getheader(name, default) class RESTClientObject(object): diff --git a/sdks/python/templates/setup.mustache b/sdks/python/templates/setup.mustache index 3d88fb387..627920071 100644 --- a/sdks/python/templates/setup.mustache +++ b/sdks/python/templates/setup.mustache @@ -1,7 +1,9 @@ {{>partial_header}} from setuptools import setup, find_packages # noqa: H301 +{{#useCustomTemplateCode}} from pathlib import Path +{{/useCustomTemplateCode}} NAME = "{{{projectName}}}" VERSION = "{{packageVersion}}" @@ -30,14 +32,21 @@ REQUIRES = [ {{/hasHttpSignatureMethods}} ] +{{#useCustomTemplateCode}} this_directory = Path(__file__).parent long_description = (this_directory / "README.md").read_text() +{{/useCustomTemplateCode}} setup( name=NAME, version=VERSION, description="{{appName}}", +{{^useCustomTemplateCode}} + author="{{infoName}}{{^infoName}}OpenAPI Generator community{{/infoName}}", +{{/useCustomTemplateCode}} +{{#useCustomTemplateCode}} author="{{packageAuthor}}", +{{/useCustomTemplateCode}} author_email="{{infoEmail}}{{^infoEmail}}team@openapitools.org{{/infoEmail}}", url="{{packageUrl}}", keywords=["OpenAPI", "OpenAPI-Generator", "{{{appName}}}"], @@ -45,9 +54,17 @@ setup( install_requires=REQUIRES, packages=find_packages(exclude=["test", "tests"]), include_package_data=True, +{{^useCustomTemplateCode}} + {{#licenseInfo}}license="{{.}}", + {{/licenseInfo}}long_description="""\ + {{appDescription}} # noqa: E501 + """ +{{/useCustomTemplateCode}} +{{#useCustomTemplateCode}} {{#licenseInfo}}license="{{.}}", {{/licenseInfo}}long_description=long_description, long_description_content_type='text/markdown' +{{/useCustomTemplateCode}} ) {{/-last}} {{/apis}}