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

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
5 changes: 2 additions & 3 deletions sdks/python/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# dropbox-sign

Dropbox Sign v3 API

## Migrating from legacy SDK
Expand Down Expand Up @@ -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|
Expand Down
8 changes: 2 additions & 6 deletions sdks/python/docs/AccountApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -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|
Expand Down Expand Up @@ -53,7 +53,6 @@ with ApiClient(configuration) as api_client:


### Parameters

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| `account_create_request` | [**AccountCreateRequest**](AccountCreateRequest.md) | | |
Expand Down Expand Up @@ -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] |
Expand Down Expand Up @@ -192,7 +190,6 @@ with ApiClient(configuration) as api_client:


### Parameters

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| `account_update_request` | [**AccountUpdateRequest**](AccountUpdateRequest.md) | | |
Expand Down Expand Up @@ -263,7 +260,6 @@ with ApiClient(configuration) as api_client:


### Parameters

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| `account_verify_request` | [**AccountVerifyRequest**](AccountVerifyRequest.md) | | |
Expand Down
6 changes: 2 additions & 4 deletions sdks/python/docs/AccountCreateRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,13 @@


## Properties

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
| `email_address`<sup>*_required_</sup> | ```str``` | The email address which will be associated with the new Account. | |
| `client_id` | ```str``` | Used when creating a new account with OAuth authorization.<br><br>See [OAuth 2.0 Authorization](https://app.hellosign.com/api/oauthWalkthrough#OAuthAuthorization) | |
| `client_secret` | ```str``` | Used when creating a new account with OAuth authorization.<br><br>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)


6 changes: 2 additions & 4 deletions sdks/python/docs/AccountCreateResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)


6 changes: 2 additions & 4 deletions sdks/python/docs/AccountGetResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)


6 changes: 2 additions & 4 deletions sdks/python/docs/AccountResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -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. | |
Expand All @@ -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)


6 changes: 2 additions & 4 deletions sdks/python/docs/AccountResponseQuotas.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,15 @@
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. | |
| `templates_left` | ```int, none_type``` | API templates remaining. | |
| `sms_verifications_left` | ```int, none_type``` | SMS verifications remaining. | |
| `num_fax_pages_left` | ```int, none_type``` | Number of fax pages left | |


[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


6 changes: 2 additions & 4 deletions sdks/python/docs/AccountResponseUsage.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)


6 changes: 2 additions & 4 deletions sdks/python/docs/AccountUpdateRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)


6 changes: 2 additions & 4 deletions sdks/python/docs/AccountVerifyRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,10 @@


## Properties

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
| `email_address`<sup>*_required_</sup> | ```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)


6 changes: 2 additions & 4 deletions sdks/python/docs/AccountVerifyResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)


6 changes: 2 additions & 4 deletions sdks/python/docs/AccountVerifyResponseAccount.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)


9 changes: 2 additions & 7 deletions sdks/python/docs/ApiAppApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -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|
Expand Down Expand Up @@ -70,7 +70,6 @@ with ApiClient(configuration) as api_client:


### Parameters

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| `api_app_create_request` | [**ApiAppCreateRequest**](ApiAppCreateRequest.md) | | |
Expand Down Expand Up @@ -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. | |
Expand Down Expand Up @@ -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. | |
Expand Down Expand Up @@ -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] |
Expand Down Expand Up @@ -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. | |
Expand Down
6 changes: 2 additions & 4 deletions sdks/python/docs/ApiAppCreateRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,8 @@


## Properties

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
| `domains`<sup>*_required_</sup> | ```[str]``` | The domain names the ApiApp will be associated with. | |
| `name`<sup>*_required_</sup> | ```str``` | The name you want to assign to the ApiApp. | |
| `callback_url` | ```str``` | The URL at which the ApiApp should receive event callbacks. | |
Expand All @@ -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)


6 changes: 2 additions & 4 deletions sdks/python/docs/ApiAppGetResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)


6 changes: 2 additions & 4 deletions sdks/python/docs/ApiAppListResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)


6 changes: 2 additions & 4 deletions sdks/python/docs/ApiAppResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -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&#39;s callback URL (for events) | |
| `client_id` | ```str``` | The app&#39;s client id | |
| `created_at` | ```int``` | The time that the app was created | |
Expand All @@ -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)


6 changes: 2 additions & 4 deletions sdks/python/docs/ApiAppResponseOAuth.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,13 @@
An object describing the app&#39;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&#39;s OAuth callback URL. | |
| `secret` | ```str``` | The app&#39;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)


6 changes: 2 additions & 4 deletions sdks/python/docs/ApiAppResponseOptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 &quot;Insert Everywhere&quot; 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)


Loading