### Install boldsign Python SDK

Source: https://github.com/boldsign/boldsign-python-sdk/blob/main/README.md

Install the package using pip. You may need root permissions.

```sh
pip install boldsign
```

--------------------------------

### Install and Configure BoldSign Python SDK

Source: https://context7.com/boldsign/boldsign-python-sdk/llms.txt

Install the SDK using pip and configure the API client with your API key and optionally a custom API URL. All API calls share the same ApiClient via a context manager.

```python
# pip install boldsign

import boldsign
import os

configuration = boldsign.Configuration(
    api_key=os.getenv("BoldSignAPIKey"),          # required
    host=os.getenv("BoldSignApiUrl", "https://api.boldsign.com")  # optional
)

# All API calls share the same ApiClient via a context manager
with boldsign.ApiClient(configuration) as api_client:
    document_api = boldsign.DocumentApi(api_client)
    template_api = boldsign.TemplateApi(api_client)
    branding_api  = boldsign.BrandingApi(api_client)
    contacts_api  = boldsign.ContactsApi(api_client)
    teams_api     = boldsign.TeamsApi(api_client)
    user_api      = boldsign.UserApi(api_client)
    plan_api      = boldsign.PlanApi(api_client)
    sender_identities_api    = boldsign.SenderIdentitiesApi(api_client)
    identity_verification_api = boldsign.IdentityVerificationApi(api_client)
    custom_field_api = boldsign.CustomFieldApi(api_client)
```

--------------------------------

### Creating and Converting SendForSign Instances

Source: https://github.com/boldsign/boldsign-python-sdk/blob/main/docs/SendForSign.md

This example demonstrates how to create a SendForSign instance from a JSON string, convert it to a dictionary, and create a new instance from that dictionary.

```python
from boldsign.models.send_for_sign import SendForSign

# TODO update the JSON string below
json_string = "{}"
# create an instance of SendForSign from a JSON string
send_for_sign_instance = SendForSign.from_json(json_string)
# print the JSON string representation of the object
print(SendForSign.to_json())

# convert the object into a dict
send_for_sign_dict = send_for_sign_instance.to_dict()
# create an instance of SendForSign from a dict
send_for_sign_from_dict = SendForSign.from_dict(send_for_sign_dict)
```

--------------------------------

### AccessCodeDetail Model Usage Example

Source: https://github.com/boldsign/boldsign-python-sdk/blob/main/docs/AccessCodeDetail.md

Example demonstrating how to create and use an AccessCodeDetail instance from a JSON string or a dictionary.

```APIDOC
## Example Usage

```python
from boldsign.models.access_code_detail import AccessCodeDetail

# TODO update the JSON string below
json_string = "{}"

# Create an instance of AccessCodeDetail from a JSON string
access_code_detail_instance = AccessCodeDetail.from_json(json_string)

# Print the JSON string representation of the object
print(AccessCodeDetail.to_json())

# Convert the object into a dictionary
access_code_detail_dict = access_code_detail_instance.to_dict()

# Create an instance of AccessCodeDetail from a dictionary
access_code_detail_from_dict = AccessCodeDetail.from_dict(access_code_detail_dict)
```
```

--------------------------------

### Import boldsign Package

Source: https://github.com/boldsign/boldsign-python-sdk/blob/main/README.md

Import the boldsign package after installation.

```python
import boldsign
```

--------------------------------

### FormField Usage Example

Source: https://github.com/boldsign/boldsign-python-sdk/blob/main/docs/FormField.md

This example demonstrates how to create and manipulate `FormField` objects using the Boldsign Python SDK, including converting between JSON strings, dictionaries, and object instances.

```APIDOC
## FormField Example

This section provides an example of how to use the `FormField` model.

```python
from boldsign.models.form_field import FormField

# TODO update the JSON string below
json = "{}"
# create an instance of FormField from a JSON string
form_field_instance = FormField.from_json(json)
# print the JSON string representation of the object
print(FormField.to_json())

# convert the object into a dict
form_field_dict = form_field_instance.to_dict()
# create an instance of FormField from a dict
form_field_from_dict = FormField.from_dict(form_field_dict)
```

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

--------------------------------

### AuditTrail Model Usage Example

Source: https://github.com/boldsign/boldsign-python-sdk/blob/main/docs/AuditTrail.md

This example demonstrates how to create an AuditTrail instance from a JSON string, convert it to a dictionary, and create an instance from a dictionary using the Boldsign Python SDK.

```python
from boldsign.models.audit_trail import AuditTrail

# TODO update the JSON string below
json_string = "{}"

# create an instance of AuditTrail from a JSON string
audit_trail_instance = AuditTrail.from_json(json_string)

# print the JSON string representation of the object
print(AuditTrail.to_json())

# convert the object into a dict
audit_trail_dict = audit_trail_instance.to_dict()

# create an instance of AuditTrail from a dict
audit_trail_from_dict = AuditTrail.from_dict(audit_trail_dict)
```

--------------------------------

### List Templates using Python SDK

Source: https://github.com/boldsign/boldsign-python-sdk/blob/main/docs/TemplateApi.md

This example demonstrates how to list all templates available in your Boldsign account. It supports various optional parameters for filtering, such as template type, creation date, and shared status. Configure your API key before execution.

```python
import boldsign
from boldsign.models.template_records import TemplateRecords
from boldsign.rest import ApiException
from pprint import pprint

configuration = boldsign.Configuration(
    api_key = "***your_api_key***"
)

# Enter a context with an instance of the API client
with boldsign.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = boldsign.TemplateApi(api_client)
    page = 1 # int |  (default to 1)
    template_type = 'template_type_example' # str |  (optional)
    page_size = 10 # int |  (optional) (default to 10)
    search_key = 'search_key_example' # str |  (optional)
    on_behalf_of = ['on_behalf_of_example'] # List[str] | The sender identity's email used to filter the templates returned in the API. The API will return templates that were sent on behalf of the specified email address. (optional)
    created_by = ['created_by_example'] # List[str] | The templates can be listed by the creator of the template. (optional)
    template_labels = ['template_labels_example'] # List[str] | Labels of the template. (optional)
    start_date = '2013-10-20T19:20:30+01:00' # datetime | Start date of the template (optional)
    end_date = '2013-10-20T19:20:30+01:00' # datetime | End date of the template (optional)
    brand_ids = ['brand_ids_example'] # List[str] | BrandId(s) of the template. (optional)
    shared_with_team_id = ['shared_with_team_id_example'] # List[str] | The templates can be listed by the shared teams. (optional)

    try:
        # List all the templates.
        api_response = api_instance.list_templates(page, template_type=template_type, page_size=page_size, search_key=search_key, on_behalf_of=on_behalf_of, created_by=created_by, template_labels=template_labels, start_date=start_date, end_date=end_date, brand_ids=brand_ids, shared_with_team_id=shared_with_team_id)
        print("The response of TemplateApi->list_templates:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TemplateApi->list_templates: %s\n" % e)
```

--------------------------------

### Manage Users with UserApi

Source: https://context7.com/boldsign/boldsign-python-sdk/llms.txt

Use UserApi to invite, list, get, update, and cancel user invitations. Ensure the BoldSignAPIKey environment variable is configured.

```python
import boldsign, os

configuration = boldsign.Configuration(api_key=os.getenv("BoldSignAPIKey"))

with boldsign.ApiClient(configuration) as api_client:
    user_api = boldsign.UserApi(api_client)

    # Create a user
    user_api.create_user(
        create_user=[
            boldsign.CreateUser(
                emailId="alice@example.com",
                teamId="0274212c-cf83-4f99-9c8f-6791f90f4386",
                userRole="Admin",
                metaData={
                    "Employee": "Permanent",
                    "Department": "Engineering",
                    "Designation": "Senior Developer"
                }
            )
        ]
    )

    # List users
    users = user_api.list_users(page=1, page_size=10)
    for u in users.result:
        print(f"{u.email_id} — Role: {u.user_role}")

    # Get a user
    user = user_api.get_user(user_id="USER_ID_HERE")

    # Update user role
    user_api.update_user(
        user_id="USER_ID_HERE",
        update_user=boldsign.UpdateUser(userRole="Member")
    )

    # Cancel pending invitation
    user_api.cancel_invitation(user_id="USER_ID_HERE")
```

--------------------------------

### Get Template Properties using Python SDK

Source: https://github.com/boldsign/boldsign-python-sdk/blob/main/docs/TemplateApi.md

Use this snippet to retrieve the summary of a specific template by its ID. Ensure you have the Boldsign SDK installed and configured with your API key.

```python
import boldsign
from boldsign.models.template_properties import TemplateProperties
from boldsign.rest import ApiException
from pprint import pprint

configuration = boldsign.Configuration(
    api_key = "***your_api_key***"
)

# Enter a context with an instance of the API client
with boldsign.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = boldsign.TemplateApi(api_client)
    template_id = 'template_id_example' # str | Template Id. 

    try:
        # Get summary of the template.
        api_response = api_instance.get_properties(template_id)
        print("The response of TemplateApi->get_properties:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TemplateApi->get_properties: %s\n" % e)
```

--------------------------------

### Get Contact Details using Python SDK

Source: https://github.com/boldsign/boldsign-python-sdk/blob/main/docs/ContactsApi.md

Retrieve detailed information about a specific contact using their ID. This example demonstrates setting up the API client and handling potential API exceptions.

```python
import boldsign
from boldsign.models.contacts_details import ContactsDetails
from boldsign.rest import ApiException
from pprint import pprint

configuration = boldsign.Configuration(
    api_key = "***your_api_key***"
)
```

--------------------------------

### Get Sender Identity by ID or Email

Source: https://github.com/boldsign/boldsign-python-sdk/blob/main/docs/SenderIdentitiesApi.md

Retrieves sender identity properties using either the sender's ID or email address. Ensure you have the correct configuration and API client setup.

```python
import boldsign
from boldsign.rest import ApiException
from pprint import pprint

configuration = boldsign.Configuration(
    api_key = "***your_api_key***"
)

# Enter a context with an instance of the API client
with boldsign.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = boldsign.SenderIdentitiesApi(api_client)
    id = 'id_example' # str | The sender identity id. (optional)
    email = 'email_example' # str | The sender identity email. (optional)

    try:
        # Gets sender identity by ID or email.
        api_response = api_instance.get_sender_identity_properties(id=id, email=email)
        print("The response of SenderIdentitiesApi->get_sender_identity_properties:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SenderIdentitiesApi->get_sender_identity_properties: %s\n" % e)
```

--------------------------------

### Initialize BoldSign Client with API Key

Source: https://github.com/boldsign/boldsign-python-sdk/blob/main/docs/DocumentApi.md

Configure the BoldSign client using an API key for authentication. Replace '***your_api_key***' with your actual API key.

```python
import boldsign
from boldsign.models.document_records import DocumentRecords
from boldsign.rest import ApiException
from pprint import pprint

configuration = boldsign.Configuration(
    api_key = "***your_api_key***"
)

```

--------------------------------

### Get Sender Identity Properties

Source: https://github.com/boldsign/boldsign-python-sdk/blob/main/docs/SenderIdentitiesApi.md

Retrieves sender identity details using either the identity's ID or the associated email address. Requires API key authentication and proper client setup.

```python
import boldsign
from boldsign.models.sender_identity_view_model import SenderIdentityViewModel
from boldsign.rest import ApiException
from pprint import pprint

configuration = boldsign.Configuration(
    api_key = "***your_api_key***"
)

```

--------------------------------

### Instantiate DocumentEdited from JSON and Dict

Source: https://github.com/boldsign/boldsign-python-sdk/blob/main/docs/DocumentEdited.md

Demonstrates creating a DocumentEdited instance from a JSON string and a dictionary. Also shows converting the instance back to JSON and a dictionary.

```python
from boldsign.models.document_edited import DocumentEdited

# TODO update the JSON string below
json = "{}"
# create an instance of DocumentEdited from a JSON string
document_edited_instance = DocumentEdited.from_json(json)
# print the JSON string representation of the object
print(DocumentEdited.to_json())

# convert the object into a dict
document_edited_dict = document_edited_instance.to_dict()
# create an instance of DocumentEdited from a dict
document_edited_from_dict = DocumentEdited.from_dict(document_edited_dict)
```

--------------------------------

### Instantiate BrandingRecords from JSON and Dictionary

Source: https://github.com/boldsign/boldsign-python-sdk/blob/main/docs/BrandingRecords.md

Demonstrates creating a BrandingRecords instance from a JSON string and a dictionary. Also shows converting an instance back to a dictionary and printing its JSON representation.

```python
from boldsign.models.branding_records import BrandingRecords

# TODO update the JSON string below
json = "{}"
# create an instance of BrandingRecords from a JSON string
branding_records_instance = BrandingRecords.from_json(json)
# print the JSON string representation of the object
print(BrandingRecords.to_json())

# convert the object into a dict
branding_records_dict = branding_records_instance.to_dict()
# create an instance of BrandingRecords from a dict
branding_records_from_dict = BrandingRecords.from_dict(branding_records_dict)
```

--------------------------------

### Instantiate CustomDomainSettings from JSON and Dict

Source: https://github.com/boldsign/boldsign-python-sdk/blob/main/docs/CustomDomainSettings.md

Demonstrates creating a CustomDomainSettings object from a JSON string or a dictionary, and converting it back to JSON or a dictionary. Ensure the JSON string is valid.

```python
from boldsign.models.custom_domain_settings import CustomDomainSettings

# TODO update the JSON string below
json = "{}"
# create an instance of CustomDomainSettings from a JSON string
custom_domain_settings_instance = CustomDomainSettings.from_json(json)
# print the JSON string representation of the object
print(CustomDomainSettings.to_json())

# convert the object into a dict
custom_domain_settings_dict = custom_domain_settings_instance.to_dict()
# create an instance of CustomDomainSettings from a dict
custom_domain_settings_from_dict = CustomDomainSettings.from_dict(custom_domain_settings_dict)
```

--------------------------------

### Instantiate ViewBrandDetails from JSON and Dict

Source: https://github.com/boldsign/boldsign-python-sdk/blob/main/docs/ViewBrandDetails.md

Demonstrates how to create a ViewBrandDetails object from a JSON string or a Python dictionary, and how to convert it back to JSON or a dictionary. Ensure the JSON string is valid and properly formatted.

```python
from boldsign.models.view_brand_details import ViewBrandDetails

# TODO update the JSON string below
json = "{}"
# create an instance of ViewBrandDetails from a JSON string
view_brand_details_instance = ViewBrandDetails.from_json(json)
# print the JSON string representation of the object
print(ViewBrandDetails.to_json())

# convert the object into a dict
view_brand_details_dict = view_brand_details_instance.to_dict()
# create an instance of ViewBrandDetails from a dict
view_brand_details_from_dict = ViewBrandDetails.from_dict(view_brand_details_dict)
```

--------------------------------

### Create and Use ReminderSettings

Source: https://github.com/boldsign/boldsign-python-sdk/blob/main/docs/ReminderSettings.md

Demonstrates how to create a ReminderSettings instance from a JSON string, convert it to a dictionary, and create a new instance from a dictionary. Ensure the JSON string is valid.

```python
from boldsign.models.reminder_settings import ReminderSettings

# TODO update the JSON string below
json = "{}"
# create an instance of ReminderSettings from a JSON string
reminder_settings_instance = ReminderSettings.from_json(json)
# print the JSON string representation of the object
print(ReminderSettings.to_json())

# convert the object into a dict
reminder_settings_dict = reminder_settings_instance.to_dict()
# create an instance of ReminderSettings from a dict
reminder_settings_from_dict = ReminderSettings.from_dict(reminder_settings_dict)
```

--------------------------------

### Get User

Source: https://github.com/boldsign/boldsign-python-sdk/blob/main/docs/UserApi.md

Retrieves the summary of a specific user by their ID.

```APIDOC
## GET /users/{user_id}

### Description
Get summary of the user.

### Method
GET

### Endpoint
/users/{user_id}

### Parameters
#### Path Parameters
- **user_id** (str) - Required - User Id.

### Response
#### Success Response (200)
- **UserProperties** - Details of the user.

#### Response Example
{
  "example": "UserProperties object"
}

### Authorization
[X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
```

--------------------------------

### SendForSign Model Initialization and Conversion

Source: https://github.com/boldsign/boldsign-python-sdk/blob/main/docs/SendForSign.md

Demonstrates how to create a SendForSign instance from a JSON string, convert it to a dictionary, and create a new instance from that dictionary. Ensure the JSON string is valid and properly formatted.

```python
from boldsign.models.send_for_sign import SendForSign

# TODO update the JSON string below
json = "{}"
# create an instance of SendForSign from a JSON string
send_for_sign_instance = SendForSign.from_json(json)
# print the JSON string representation of the object
print(SendForSign.to_json())

# convert the object into a dict
send_for_sign_dict = send_for_sign_instance.to_dict()
# create an instance of SendForSign from a dict
send_for_sign_from_dict = SendForSign.from_dict(send_for_sign_dict)
```

--------------------------------

### Get Contact

Source: https://github.com/boldsign/boldsign-python-sdk/blob/main/docs/ContactsApi.md

Retrieves the summary details of a specific contact.

```APIDOC
## GET /v1/contacts/get

### Description
Get summary of the contact.

### Method
GET

### Endpoint
/v1/contacts/get

### Authorization
[X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
```

--------------------------------

### Instantiate CollaborationSettings from JSON and Dict

Source: https://github.com/boldsign/boldsign-python-sdk/blob/main/docs/CollaborationSettings.md

Demonstrates creating a CollaborationSettings object from a JSON string or a dictionary. Use this when you need to parse existing collaboration settings data.

```python
from boldsign.models.collaboration_settings import CollaborationSettings

# TODO update the JSON string below
json = "{}"
# create an instance of CollaborationSettings from a JSON string
collaboration_settings_instance = CollaborationSettings.from_json(json)
# print the JSON string representation of the object
print(CollaborationSettings.to_json())

# convert the object into a dict
collaboration_settings_dict = collaboration_settings_instance.to_dict()
# create an instance of CollaborationSettings from a dict
collaboration_settings_from_dict = CollaborationSettings.from_dict(collaboration_settings_dict)
```

--------------------------------

### Create IdentityVerificationSettings Instance

Source: https://github.com/boldsign/boldsign-python-sdk/blob/main/docs/IdentityVerificationSettings.md

Demonstrates how to create an instance of IdentityVerificationSettings from a JSON string and a dictionary. Also shows how to convert the object to a dictionary and print its JSON representation.

```python
from boldsign.models.identity_verification_settings import IdentityVerificationSettings

# TODO update the JSON string below
json = "{}"
# create an instance of IdentityVerificationSettings from a JSON string
identity_verification_settings_instance = IdentityVerificationSettings.from_json(json)
# print the JSON string representation of the object
print(IdentityVerificationSettings.to_json())

# convert the object into a dict
identity_verification_settings_dict = identity_verification_settings_instance.to_dict()
# create an instance of IdentityVerificationSettings from a dict
identity_verification_settings_from_dict = IdentityVerificationSettings.from_dict(identity_verification_settings_dict)
```

--------------------------------

### Get Team

Source: https://github.com/boldsign/boldsign-python-sdk/blob/main/docs/TeamsApi.md

Retrieves the details of a specific team using its ID.

```APIDOC
## GET /v1/teams/get

### Description
Get Team details.

### Method
GET

### Endpoint
/v1/teams/get

### Parameters
#### Query Parameters
- **team_id** (string) - Required - The ID of the team to retrieve.

### Response
#### Success Response (200)
- **TeamResponse** (TeamResponse) - Details of the requested team.

#### Response Example
```json
{
  "example": "response body"
}
```
```

--------------------------------

### Get Template Properties

Source: https://github.com/boldsign/boldsign-python-sdk/blob/main/docs/TemplateApi.md

Retrieves a summary of a specific template using its ID.

```APIDOC
## GET /templates/{template_id}

### Description
Get summary of the template.

### Method
GET

### Endpoint
/templates/{template_id}

### Parameters
#### Path Parameters
- **template_id** (str) - Required - Template Id.

### Response
#### Success Response (200)
- **TemplateProperties** - Details about the template properties.

### Authorization
[X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
```

--------------------------------

### Instantiate and Convert BillingViewModel

Source: https://github.com/boldsign/boldsign-python-sdk/blob/main/docs/BillingViewModel.md

Demonstrates creating a BillingViewModel instance from a JSON string and converting it to a dictionary. Also shows converting back from a dictionary. Ensure the JSON string is valid.

```python
from boldsign.models.billing_view_model import BillingViewModel

# TODO update the JSON string below
json = "{}"
# create an instance of BillingViewModel from a JSON string
billing_view_model_instance = BillingViewModel.from_json(json)
# print the JSON string representation of the object
print(BillingViewModel.to_json())

# convert the object into a dict
billing_view_model_dict = billing_view_model_instance.to_dict()
# create an instance of BillingViewModel from a dict
billing_view_model_from_dict = BillingViewModel.from_dict(billing_view_model_dict)
```

--------------------------------

### Instantiate AuthenticationSettings from JSON and Dict

Source: https://github.com/boldsign/boldsign-python-sdk/blob/main/docs/AuthenticationSettings.md

Demonstrates creating an AuthenticationSettings object from a JSON string or a dictionary. Includes converting the object back to JSON and a dictionary.

```python
from boldsign.models.authentication_settings import AuthenticationSettings

# TODO update the JSON string below
json = "{}"
# create an instance of AuthenticationSettings from a JSON string
authentication_settings_instance = AuthenticationSettings.from_json(json)
# print the JSON string representation of the object
print(AuthenticationSettings.to_json())

# convert the object into a dict
authentication_settings_dict = authentication_settings_instance.to_dict()
# create an instance of AuthenticationSettings from a dict
authentication_settings_from_dict = AuthenticationSettings.from_dict(authentication_settings_dict)
```

--------------------------------

### Get specific brand details

Source: https://github.com/boldsign/boldsign-python-sdk/blob/main/docs/BrandingApi.md

Retrieves the details of a specific brand by its ID.

```APIDOC
## GET /v1/brand/get

### Description
Get the specific brand details.

### Method
GET

### Endpoint
/v1/brand/get

### Parameters
#### Query Parameters
- **brandId** (string) - Required - The ID of the brand to retrieve.

### Response
#### Success Response (200)
- **Brand** (object) - Details of the specific brand.

### Authorization
[X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)

### Request Example
```python
import boldsign
from boldsign.rest import ApiException
from pprint import pprint

configuration = boldsign.Configuration(
    api_key = "***your_api_key***"
)

with boldsign.ApiClient(configuration) as api_client:
    api_instance = boldsign.BrandingApi(api_client)
    try:
        brand_id = "your_brand_id" # Replace with the actual brand ID
        api_response = api_instance.get_brand(brand_id=brand_id)
        pprint(api_response)
    except Exception as e:
        print("Exception when calling BrandingApi->get_brand: %s\n" % e)
```
```

--------------------------------

### Instantiate UserRecords from JSON and Dict

Source: https://github.com/boldsign/boldsign-python-sdk/blob/main/docs/UserRecords.md

Demonstrates creating UserRecords instances from JSON strings and dictionaries, and converting them back. Ensure the JSON string is valid.

```python
from boldsign.models.user_records import UserRecords

# TODO update the JSON string below
json = "{}"
# create an instance of UserRecords from a JSON string
user_records_instance = UserRecords.from_json(json)
# print the JSON string representation of the object
print(UserRecords.to_json())

# convert the object into a dict
user_records_dict = user_records_instance.to_dict()
# create an instance of UserRecords from a dict
user_records_from_dict = UserRecords.from_dict(user_records_dict)
```

--------------------------------

### Get Group Contact

Source: https://github.com/boldsign/boldsign-python-sdk/blob/main/docs/GroupContactsApi.md

Retrieves the summary details of a specific group contact.

```APIDOC
## GET /v1/contactGroups/get

### Description
Get Summary of the Group Contact.

### Method
GET

### Endpoint
/v1/contactGroups/get

### Parameters
(Parameters not specified in source)

### Response
(Response details not specified in source)

### Request Example
(Request example not provided in source)
```

--------------------------------

### Instantiate DocumentProperties from JSON and Dict

Source: https://github.com/boldsign/boldsign-python-sdk/blob/main/docs/DocumentProperties.md

Demonstrates how to create a DocumentProperties object from a JSON string or a dictionary, and how to convert it back to a dictionary. Ensure the JSON string is valid.

```python
from boldsign.models.document_properties import DocumentProperties

# TODO update the JSON string below
json = "{}"
# create an instance of DocumentProperties from a JSON string
document_properties_instance = DocumentProperties.from_json(json)
# print the JSON string representation of the object
print(DocumentProperties.to_json())

# convert the object into a dict
document_properties_dict = document_properties_instance.to_dict()
# create an instance of DocumentProperties from a dict
document_properties_from_dict = DocumentProperties.from_dict(document_properties_dict)
```

--------------------------------

### Get Document Properties

Source: https://github.com/boldsign/boldsign-python-sdk/blob/main/docs/DocumentApi.md

Retrieves a summary of a specific document using its unique identifier.

```APIDOC
## GET /documents/{document_id}/properties

### Description
Get summary of the document.

### Method
GET

### Endpoint
/documents/{document_id}/properties

### Parameters
#### Path Parameters
- **document_id** (str) - Required - Document Id.

### Response
#### Success Response (200)
- **DocumentProperties** - Details about the document properties.

### Authorization
[X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
```

--------------------------------

### Create a Brand Profile with BoldSign SDK

Source: https://context7.com/boldsign/boldsign-python-sdk/llms.txt

Creates a custom brand profile including logo, colors, and email settings. Requires BoldSignAPIKey environment variable.

```python
import boldsign, os

configuration = boldsign.Configuration(api_key=os.getenv("BoldSignAPIKey"))

with boldsign.ApiClient(configuration) as api_client:
    branding_api = boldsign.BrandingApi(api_client)

    result = branding_api.create_brand(
        brand_name="Acme Corp",
        background_color="#FFFFFF",
        button_color="#0066CC",
        button_text_color="#FFFFFF",
        email_display_name="{SenderName} from Acme Corp",
        redirect_url="https://acmecorp.com/",
        is_default=True,
        can_hide_tag_line=True,
        combine_audit_trail=True,
        document_time_zone="+05:30",
        email_signed_document="1",
        hide_decline=False,
        hide_save=False,
        brand_logo="path/to/logo.png"
    )
    print(f"Brand created. ID: {result.brand_id}")
```

--------------------------------

### Get Contact Details

Source: https://github.com/boldsign/boldsign-python-sdk/blob/main/docs/ContactsApi.md

Retrieves the summary of a specific contact using their unique ID.

```APIDOC
## GET /contacts/{id}

### Description
Retrieves the summary of a specific contact.

### Method
GET

### Endpoint
/contacts/{id}

### Parameters
#### Path Parameters
- **id** (str) - Required - Contact Id.

### Response
#### Success Response (200)
- **ContactsDetails** (ContactsDetails) - Description of the contact details.

#### Response Example
{
  "example": "ContactsDetails object"
}

### Authorization
[X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)

### HTTP request headers
 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details
| Status code | Description |
|-------------|-------------|
**200** | OK |
**401** | Unauthorized |
**403** | Forbidden |
```

--------------------------------

### Get Team Documents

Source: https://github.com/boldsign/boldsign-python-sdk/blob/main/docs/DocumentApi.md

Retrieves a list of team documents with various filtering and pagination options.

```APIDOC
## GET /documents/team

### Description
Retrieves a list of team documents based on specified filters and pagination.

### Method
GET

### Endpoint
/documents/team

### Parameters
#### Query Parameters
- **page** (int) - Required - Page index specified in get document list request.
- **user_id** (List[str]) - Optional - UserId of the Team document.
- **team_id** (List[str]) - Optional - TeamId of the Team document.
- **transmit_type** (str) - Optional - Transmit type as Sent, Received and Both.
- **date_filter_type** (str) - Optional - Date Filter as SentBetween and Expiring.
- **page_size** (int) - Optional - Page size specified in get document list request. [default to 10]
- **start_date** (datetime) - Optional - Start date of the document.
- **status** (List[str]) - Optional - Status of the document such as In-progress, Completed, Decline, Expired, Revoked, Draft.
- **end_date** (datetime) - Optional - End date of the document.
- **search_key** (str) - Optional - Documents can be listed by the search key present in the document like document title, document ID, sender or recipient(s) name, etc.
- **labels** (List[str]) - Optional - Labels of the document.
- **next_cursor** (int) - Optional - Next cursor value for pagination, required for fetching the next set of documents beyond 10,000 records.
- **brand_ids** (List[str]) - Optional - BrandId(s) of the document.

### Response
#### Success Response (200)
- **TeamDocumentRecords** (TeamDocumentRecords) - OK

#### Response Example
{
  "example": "response body"
}

### Authorization
[X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
```

--------------------------------

### Instantiate FormulaFieldSettings from JSON and Dict

Source: https://github.com/boldsign/boldsign-python-sdk/blob/main/docs/FormulaFieldSettings.md

Demonstrates creating a FormulaFieldSettings object from a JSON string or a dictionary. Includes converting the object back to JSON and a dictionary.

```python
from boldsign.models.formula_field_settings import FormulaFieldSettings

# TODO update the JSON string below
json = "{}"
# create an instance of FormulaFieldSettings from a JSON string
formula_field_settings_instance = FormulaFieldSettings.from_json(json)
# print the JSON string representation of the object
print(FormulaFieldSettings.to_json())

# convert the object into a dict
formula_field_settings_dict = formula_field_settings_instance.to_dict()
# create an instance of FormulaFieldSettings from a dict
formula_field_settings_from_dict = FormulaFieldSettings.from_dict(formula_field_settings_dict)
```

--------------------------------

### CreateUser Model Usage

Source: https://github.com/boldsign/boldsign-python-sdk/blob/main/docs/CreateUser.md

Demonstrates how to create an instance of the CreateUser model from a JSON string and convert it to a dictionary. Also shows how to create an instance from a dictionary.

```python
from boldsign.models.create_user import CreateUser

# TODO update the JSON string below
json = "{}"
# create an instance of CreateUser from a JSON string
create_user_instance = CreateUser.from_json(json)
# print the JSON string representation of the object
print(CreateUser.to_json())

# convert the object into a dict
create_user_dict = create_user_instance.to_dict()
# create an instance of CreateUser from a dict
create_user_from_dict = CreateUser.from_dict(create_user_dict)
```

--------------------------------

### get_properties

Source: https://github.com/boldsign/boldsign-python-sdk/blob/main/docs/TemplateApi.md

Get summary properties of a template. This endpoint retrieves metadata and details about a specific template.

```APIDOC
## GET /v1/template/properties

### Description
Get summary of the template.

### Method
GET

### Endpoint
/v1/template/properties

### Parameters
#### Query Parameters
- **template_id** (string) - Required - The ID of the template to get properties for.

### Request Example
```
GET /v1/template/properties?template_id=tpl_abc123
```

### Response
#### Success Response (200)
- **template_id** (string) - The ID of the template.
- **template_name** (string) - The name of the template.
- **created_at** (string) - The date and time the template was created.
- **updated_at** (string) - The date and time the template was last updated.

### Response Example
```json
{
  "template_id": "tpl_abc123",
  "template_name": "Invoice Template",
  "created_at": "2023-10-27T10:00:00Z",
  "updated_at": "2023-10-27T10:00:00Z"
}
```
```

--------------------------------

### get_user

Source: https://github.com/boldsign/boldsign-python-sdk/blob/main/docs/UserApi.md

Get summary of the user. This operation retrieves a summary of a specific user's information.

```APIDOC
## GET /v1/users/get

### Description
Get summary of the user.

### Method
GET

### Endpoint
/v1/users/get

### Response
#### Success Response (200)
Returns a summary of the user's details.

### Authorization
[X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
```

--------------------------------

### Instantiate BehalfDocument from JSON and Dict

Source: https://github.com/boldsign/boldsign-python-sdk/blob/main/docs/BehalfDocument.md

Demonstrates creating a BehalfDocument instance from a JSON string and a dictionary. Also shows converting an instance back to a dictionary and JSON string.

```python
from boldsign.models.behalf_document import BehalfDocument

# TODO update the JSON string below
json = "{}"
# create an instance of BehalfDocument from a JSON string
behalf_document_instance = BehalfDocument.from_json(json)
# print the JSON string representation of the object
print(BehalfDocument.to_json())

# convert the object into a dict
behalf_document_dict = behalf_document_instance.to_dict()
# create an instance of BehalfDocument from a dict
behalf_document_from_dict = BehalfDocument.from_dict(behalf_document_dict)
```

--------------------------------

### Instantiate and Use ChangeTeamRequest

Source: https://github.com/boldsign/boldsign-python-sdk/blob/main/docs/ChangeTeamRequest.md

Demonstrates how to create a ChangeTeamRequest instance from a JSON string and a dictionary. Also shows how to convert the object to a dictionary. Requires the ChangeTeamRequest model to be imported.

```python
from boldsign.models.change_team_request import ChangeTeamRequest

# TODO update the JSON string below
json = "{}"
# create an instance of ChangeTeamRequest from a JSON string
change_team_request_instance = ChangeTeamRequest.from_json(json)
# print the JSON string representation of the object
print(ChangeTeamRequest.to_json())

# convert the object into a dict
change_team_request_dict = change_team_request_instance.to_dict()
# create an instance of ChangeTeamRequest from a dict
change_team_request_from_dict = ChangeTeamRequest.from_dict(change_team_request_dict)
```

--------------------------------

### Get API Credits Count

Source: https://github.com/boldsign/boldsign-python-sdk/blob/main/docs/PlanApi.md

Retrieves the current API credit balance and details for the account.

```APIDOC
## GET /v1/plan/apiCreditsCount

### Description
Gets the Api credits details.

### Method
GET

### Endpoint
/v1/plan/apiCreditsCount

### Parameters
This endpoint does not need any parameter.

### Request Example
```python
import boldsign
from boldsign.models.billing_view_model import BillingViewModel
from boldsign.rest import ApiException
from pprint import pprint

configuration = boldsign.Configuration(
    api_key = "***your_api_key***"
)

# Enter a context with an instance of the API client
with boldsign.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = boldsign.PlanApi(api_client)

    try:
        # Gets the Api credits details.
        api_response = api_instance.api_credits_count()
        print("The response of PlanApi->api_credits_count:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PlanApi->api_credits_count: %s\n" % e)
```

### Response
#### Success Response (200)
- **BillingViewModel** - Details about the billing and API credits.

#### Response Example
(Response body structure would be detailed here if provided in source)
```

--------------------------------

### Instantiate ViewCustomFieldDetails from JSON and Dictionary

Source: https://github.com/boldsign/boldsign-python-sdk/blob/main/docs/ViewCustomFieldDetails.md

Demonstrates creating a ViewCustomFieldDetails object from a JSON string or a dictionary. Also shows how to convert the object back to a dictionary or JSON string.

```python
from boldsign.models.view_custom_field_details import ViewCustomFieldDetails

# TODO update the JSON string below
json = "{}"
# create an instance of ViewCustomFieldDetails from a JSON string
view_custom_field_details_instance = ViewCustomFieldDetails.from_json(json)
# print the JSON string representation of the object
print(ViewCustomFieldDetails.to_json())

# convert the object into a dict
view_custom_field_details_dict = view_custom_field_details_instance.to_dict()
# create an instance of ViewCustomFieldDetails from a dict
view_custom_field_details_from_dict = ViewCustomFieldDetails.from_dict(view_custom_field_details_dict)
```

--------------------------------

### Get Sender Identity Properties

Source: https://github.com/boldsign/boldsign-python-sdk/blob/main/docs/SenderIdentitiesApi.md

Retrieves the properties of a sender identity, identified by its ID or email address.

```APIDOC
## GET /v1/senderIdentities/properties

### Description
Gets sender identity by ID or email.

### Method
GET

### Endpoint
/v1/senderIdentities/properties
```

--------------------------------

### Create NotificationSettings from JSON and Dict

Source: https://github.com/boldsign/boldsign-python-sdk/blob/main/docs/NotificationSettings.md

Demonstrates how to create a NotificationSettings instance from a JSON string or a Python dictionary, and how to convert an instance back to a JSON string or dictionary. Ensure the JSON string is valid.

```python
from boldsign.models.notification_settings import NotificationSettings

# TODO update the JSON string below
json = "{}"
# create an instance of NotificationSettings from a JSON string
notification_settings_instance = NotificationSettings.from_json(json)
# print the JSON string representation of the object
print(NotificationSettings.to_json())

# convert the object into a dict
notification_settings_dict = notification_settings_instance.to_dict()
# create an instance of NotificationSettings from a dict
notification_settings_from_dict = NotificationSettings.from_dict(notification_settings_dict)
```

--------------------------------

### EditDocumentSigner Example Usage

Source: https://github.com/boldsign/boldsign-python-sdk/blob/main/docs/EditDocumentSigner.md

Demonstrates how to create an instance of EditDocumentSigner from a JSON string and convert it to a dictionary, and vice versa.

```python
from boldsign.models.edit_document_signer import EditDocumentSigner

# TODO update the JSON string below
json_string = "{}"
# create an instance of EditDocumentSigner from a JSON string
edit_document_signer_instance = EditDocumentSigner.from_json(json_string)
# print the JSON string representation of the object
print(EditDocumentSigner.to_json())

# convert the object into a dict
edit_document_signer_dict = edit_document_signer_instance.to_dict()
# create an instance of EditDocumentSigner from a dict
edit_document_signer_from_dict = EditDocumentSigner.from_dict(edit_document_signer_dict)
```

--------------------------------

### Roles Model Initialization and Conversion

Source: https://github.com/boldsign/boldsign-python-sdk/blob/main/docs/Roles.md

Demonstrates how to create an instance of the Roles model from a JSON string, convert it to a JSON string, and convert it to a dictionary. Ensure the JSON string is valid and properly formatted.

```python
from boldsign.models.roles import Roles

# TODO update the JSON string below
json = "{}"
# create an instance of Roles from a JSON string
roles_instance = Roles.from_json(json)
# print the JSON string representation of the object
print(Roles.to_json())

# convert the object into a dict
roles_dict = roles_instance.to_dict()
# create an instance of Roles from a dict
roles_from_dict = Roles.from_dict(roles_dict)
```

--------------------------------

### UserApi - Get User

Source: https://github.com/boldsign/boldsign-python-sdk/blob/main/README.md

Retrieves summary information about a specific user. This endpoint provides details and metadata for a user.

```APIDOC
## GET /v1/users/get

### Description
Get summary of the user.

### Method
GET

### Endpoint
/v1/users/get
```

--------------------------------

### EditFormField Usage Example

Source: https://github.com/boldsign/boldsign-python-sdk/blob/main/docs/EditFormField.md

Demonstrates how to create an instance of EditFormField from a JSON string, convert it to a dictionary, and create an instance from a dictionary.

```APIDOC
## EditFormField Example

### Description
This example shows how to use the `EditFormField` model in Python.

### Code Example

```python
from boldsign.models.edit_form_field import EditFormField

# TODO update the JSON string below
json_string = "{}"

# Create an instance of EditFormField from a JSON string
edit_form_field_instance = EditFormField.from_json(json_string)

# Print the JSON string representation of the object
print(EditFormField.to_json())

# Convert the object into a dict
edit_form_field_dict = edit_form_field_instance.to_dict()

# Create an instance of EditFormField from a dict
edit_form_field_from_dict = EditFormField.from_dict(edit_form_field_dict)
```
```

--------------------------------

### Template Model Usage

Source: https://github.com/boldsign/boldsign-python-sdk/blob/main/docs/Template.md

Demonstrates how to create a Template instance from a JSON string, convert it to a dictionary, and create a new instance from a dictionary.

```APIDOC
## Template Model Usage

### Description
This section shows how to instantiate the `Template` model using JSON or dictionary representations, and how to convert an existing instance into these formats.

### Methods
- `Template.from_json(json_string)`: Creates a `Template` instance from a JSON string.
- `Template.to_json()`: Converts a `Template` instance to its JSON string representation.
- `Template.from_dict(dictionary)`: Creates a `Template` instance from a Python dictionary.
- `Template.to_dict()`: Converts a `Template` instance to a Python dictionary.

### Code Example
```python
from boldsign.models.template import Template

# Example JSON string (replace with actual JSON data)
json_data = "{}"

# Create an instance of Template from a JSON string
template_instance = Template.from_json(json_data)

# Print the JSON string representation of the object
print(Template.to_json())

# Convert the object into a dict
template_dict = template_instance.to_dict()

# Create an instance of Template from a dict
template_from_dict = Template.from_dict(template_dict)
```
```

--------------------------------

### DocumentApi — Get Document Properties

Source: https://context7.com/boldsign/boldsign-python-sdk/llms.txt

Fetches the full metadata and signer status of a specific document using its ID.

```APIDOC
## DocumentApi — Get Document Properties

`DocumentApi.get_properties()` fetches the full metadata and signer status of a specific document. Returns a `DocumentProperties` object.

### Method
GET

### Endpoint
/v1/documents/{document_id}/properties

### Parameters
#### Path Parameters
- **document_id** (string) - Required - The ID of the document to retrieve properties for.

### Request Example
```python
import boldsign, os

configuration = boldsign.Configuration(api_key=os.getenv("BoldSignAPIKey"))

with boldsign.ApiClient(configuration) as api_client:
    document_api = boldsign.DocumentApi(api_client)

    props = document_api.get_properties(document_id="8f59295d-xxxx-xxxx-xxxx-e7dc88cfff2c")

    print(f"Title:  {props.document_title}")
    print(f"Status: {props.status}")
    for signer in props.signers:
        print(f"  Signer: {signer.name} <{signer.email_address}> — {signer.status}")
```

### Response
#### Success Response (200)
- **document_title** (string) - The title of the document.
- **status** (string) - The current status of the document.
- **signers** (list of Signer) - A list of signers for the document.
  - **name** (string) - The name of the signer.
  - **email_address** (string) - The email address of the signer.
  - **status** (string) - The status of the signer.
```

--------------------------------

### Instantiate BrandCustomFieldDetails from JSON and Dict

Source: https://github.com/boldsign/boldsign-python-sdk/blob/main/docs/BrandCustomFieldDetails.md

Demonstrates how to create a BrandCustomFieldDetails object from a JSON string or a dictionary, and how to convert it back to a dictionary. Ensure the JSON string is valid.

```python
from boldsign.models.brand_custom_field_details import BrandCustomFieldDetails

# TODO update the JSON string below
json = "{}"
# create an instance of BrandCustomFieldDetails from a JSON string
brand_custom_field_details_instance = BrandCustomFieldDetails.from_json(json)
# print the JSON string representation of the object
print(BrandCustomFieldDetails.to_json())

# convert the object into a dict
brand_custom_field_details_dict = brand_custom_field_details_instance.to_dict()
# create an instance of BrandCustomFieldDetails from a dict
brand_custom_field_details_from_dict = BrandCustomFieldDetails.from_dict(brand_custom_field_details_dict)
```

--------------------------------

### TemplateApi - Get Properties

Source: https://github.com/boldsign/boldsign-python-sdk/blob/main/README.md

Retrieves a summary of a template's properties. This endpoint provides metadata and details about a specific template.

```APIDOC
## GET /v1/template/properties

### Description
Get summary of the template.

### Method
GET

### Endpoint
/v1/template/properties
```

--------------------------------

### Get Contact Details

Source: https://github.com/boldsign/boldsign-python-sdk/blob/main/docs/ContactsApi.md

Retrieves the summary details of a specific contact using its unique identifier. This operation requires authentication.

```APIDOC
## get_contact

### Description
Get summary of the contact.

### Method
GET

### Endpoint
/api/v2/contacts/{id}

### Parameters
#### Path Parameters
- **id** (str) - Required - The contact id.

### Return type
[ContactsDetails](../models/ContactsDetails.md)

### Authorization
[X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)

### HTTP response details
| Status code | Description |
|-------------|-------------|
**200** | OK |
**401** | Unauthorized |
**404** | Not Found |
```

--------------------------------

### Instantiate Document from JSON and Dictionary

Source: https://github.com/boldsign/boldsign-python-sdk/blob/main/docs/Document.md

Demonstrates creating a Document instance from a JSON string and a dictionary. Also shows converting a Document object back to a dictionary.

```python
from boldsign.models.document import Document

# TODO update the JSON string below
json = "{}"
# create an instance of Document from a JSON string
document_instance = Document.from_json(json)
# print the JSON string representation of the object
print(Document.to_json())

# convert the object into a dict
document_dict = document_instance.to_dict()
# create an instance of Document from a dict
document_from_dict = Document.from_dict(document_dict)
```

--------------------------------

### DocumentExpirySettings Model Usage

Source: https://github.com/boldsign/boldsign-python-sdk/blob/main/docs/DocumentExpirySettings.md

Demonstrates creating a DocumentExpirySettings instance from a JSON string and converting it to a dictionary. Also shows converting a dictionary back to an instance. Ensure the JSON string is valid.

```python
from boldsign.models.document_expiry_settings import DocumentExpirySettings

# TODO update the JSON string below
json = "{}"
# create an instance of DocumentExpirySettings from a JSON string
document_expiry_settings_instance = DocumentExpirySettings.from_json(json)
# print the JSON string representation of the object
print(DocumentExpirySettings.to_json())

# convert the object into a dict
document_expiry_settings_dict = document_expiry_settings_instance.to_dict()
# create an instance of DocumentExpirySettings from a dict
document_expiry_settings_from_dict = DocumentExpirySettings.from_dict(document_expiry_settings_dict)
```

--------------------------------

### EmbeddedTemplateEditRequest Usage Example

Source: https://github.com/boldsign/boldsign-python-sdk/blob/main/docs/EmbeddedTemplateEditRequest.md

This snippet demonstrates how to use the EmbeddedTemplateEditRequest class in Python, including creating an instance from JSON and converting it to a dictionary.

```APIDOC
```python
from boldsign.models.embedded_template_edit_request import EmbeddedTemplateEditRequest

# TODO update the JSON string below
json_string = "{}"

# create an instance of EmbeddedTemplateEditRequest from a JSON string
embedded_template_edit_request_instance = EmbeddedTemplateEditRequest.from_json(json_string)

# print the JSON string representation of the object
print(EmbeddedTemplateEditRequest.to_json())

# convert the object into a dict
embedded_template_edit_request_dict = embedded_template_edit_request_instance.to_dict()

# create an instance of EmbeddedTemplateEditRequest from a dict
embedded_template_edit_request_from_dict = EmbeddedTemplateEditRequest.from_dict(embedded_template_edit_request_dict)
```
```