blindvault-sdk-api 0.1.0rc1__tar.gz

blindvault_sdk_api-0.1.0rc1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 BlindVault
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

blindvault_sdk_api-0.1.0rc1/PKG-INFO

@@ -0,0 +1,447 @@
+Metadata-Version: 2.4
+Name: blindvault_sdk_api
+Version: 0.1.0rc1
+Summary: BlindVault API
+Home-page: 
+Author: OpenAPI Generator community
+Author-email: BlindVault <devops@blindvault.com>
+License-Expression: MIT
+Project-URL: Repository, https://gitlab.com/blindvault/blindvault-sdk
+Keywords: OpenAPI,OpenAPI-Generator,BlindVault API
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: urllib3<3.0.0,>=2.7.0
+Requires-Dist: python-dateutil>=2.8.2
+Requires-Dist: pydantic>=2.11
+Requires-Dist: typing-extensions>=4.7.1
+Dynamic: author
+Dynamic: license-file
+
+# blindvault-sdk-api
+BlindVault REST API for account, library, conversation, signing, and agent workflows.
+Protected operations document their accepted authentication schemes. Request and
+response models are generated from controller DTOs; errors use Problem Details.
+
+
+This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: 1.0.0
+- Package version: 0.1.0rc1
+- Generator version: 7.26.0
+- Build package: org.openapitools.codegen.languages.PythonClientCodegen
+
+## Requirements.
+
+Python 3.10+
+
+Packaging uses standard `[project]` metadata and `[dependency-groups]` (PEP 621/735).
+Install the package with `python -m pip install .`; install development dependencies
+with Poetry 2.2 or newer using `poetry install`, or pip 25.1 or newer using
+`python -m pip install --group dev`. The latter installs the group, not the package.
+
+## Installation & Usage
+### pip install
+
+If the python package is hosted on a repository, you can install directly using:
+
+```sh
+pip install git+https://gitlab.com/blindvault/blindvault-sdk.git
+```
+(you may need to run `pip` with root permission: `sudo pip install git+https://gitlab.com/blindvault/blindvault-sdk.git`)
+
+Then import the package:
+```python
+import blindvault_sdk_api
+```
+
+### 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)
+
+Then import the package:
+```python
+import blindvault_sdk_api
+```
+
+### Tests
+
+Execute `pytest` to run the tests.
+
+## Getting Started
+
+Please follow the [installation procedure](#installation--usage) and then run the following:
+
+```python
+
+import blindvault_sdk_api
+from blindvault_sdk_api.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to https://api.eu.blindvault.com
+# See configuration.py for a list of all supported configuration parameters.
+configuration = blindvault_sdk_api.Configuration(
+    host = "https://api.eu.blindvault.com"
+)
+
+# The client must configure the authentication and authorization parameters
+# in accordance with the API server security policy.
+# Examples for each auth method are provided below, use the example that
+# satisfies your auth use case.
+
+# Configure API key authorization: apiKeyAuth
+configuration.api_key['apiKeyAuth'] = os.environ["API_KEY"]
+
+# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+# configuration.api_key_prefix['apiKeyAuth'] = 'Bearer'
+
+# Configure Bearer authorization (JWT): bearerAuth
+configuration = blindvault_sdk_api.Configuration(
+    access_token = os.environ["BEARER_TOKEN"]
+)
+
+
+# Enter a context with an instance of the API client
+with blindvault_sdk_api.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = blindvault_sdk_api.AgentApi(api_client)
+    device_id = 'device_id_example' # str | 
+    create_agent_command_request = blindvault_sdk_api.CreateAgentCommandRequest() # CreateAgentCommandRequest | 
+
+    try:
+        # Create Command
+        api_response = api_instance.create_command(device_id, create_agent_command_request)
+        print("The response of AgentApi->create_command:\n")
+        pprint(api_response)
+    except ApiException as e:
+        print("Exception when calling AgentApi->create_command: %s\n" % e)
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://api.eu.blindvault.com*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*AgentApi* | [**create_command**](docs/AgentApi.md#create_command) | **POST** /api/agents/{deviceId}/commands | Create Command
+*AgentApi* | [**get_command**](docs/AgentApi.md#get_command) | **GET** /api/agents/{deviceId}/commands/{commandId} | Get Command
+*AgentApi* | [**list_devices**](docs/AgentApi.md#list_devices) | **GET** /api/agents | List Devices
+*AgentApi* | [**revoke_device**](docs/AgentApi.md#revoke_device) | **DELETE** /api/agents/{deviceId} | Revoke Device
+*AgentApi* | [**upsert_key_grant**](docs/AgentApi.md#upsert_key_grant) | **POST** /api/agents/{deviceId}/key-grants | Upsert Key Grant
+*AgentPairingApi* | [**confirm_pairing**](docs/AgentPairingApi.md#confirm_pairing) | **POST** /api/agents/pairing/confirm | Confirm Pairing
+*AgentPairingApi* | [**get_status**](docs/AgentPairingApi.md#get_status) | **GET** /api/agents/pairing/status/{code} | Get Status
+*AgentPairingApi* | [**request_pairing**](docs/AgentPairingApi.md#request_pairing) | **POST** /api/agents/pairing/request | Request Pairing
+*AppConfigApi* | [**get_config**](docs/AppConfigApi.md#get_config) | **GET** /v1/app-config | Get Config
+*AuditApi* | [**export_process_audit**](docs/AuditApi.md#export_process_audit) | **GET** /v1/sign/audit/process/{processId}/export | Export Process Audit
+*AuditApi* | [**export_process_history**](docs/AuditApi.md#export_process_history) | **GET** /v1/sign/audit/process/{processId}/history/export | Export Process History
+*AuditApi* | [**get_audit_events_for_process**](docs/AuditApi.md#get_audit_events_for_process) | **GET** /v1/sign/audit/process/{processId} | Get Audit Events For Process
+*AuthApi* | [**login**](docs/AuthApi.md#login) | **POST** /v1/auth/login | Login
+*AuthApi* | [**register_user**](docs/AuthApi.md#register_user) | **POST** /v1/auth/register | Register User
+*CollectionsWebhookApi* | [**create_webhook2**](docs/CollectionsWebhookApi.md#create_webhook2) | **POST** /v1/collections/webhooks | Create Webhook
+*CollectionsWebhookApi* | [**delete_webhook2**](docs/CollectionsWebhookApi.md#delete_webhook2) | **DELETE** /v1/collections/webhooks/{id} | Delete Webhook
+*CollectionsWebhookApi* | [**get_webhook2**](docs/CollectionsWebhookApi.md#get_webhook2) | **GET** /v1/collections/webhooks/{id} | Get Webhook
+*CollectionsWebhookApi* | [**list_webhooks2**](docs/CollectionsWebhookApi.md#list_webhooks2) | **GET** /v1/collections/webhooks | List Webhooks
+*CollectionsWebhookApi* | [**test_webhook2**](docs/CollectionsWebhookApi.md#test_webhook2) | **POST** /v1/collections/webhooks/{id}/test | Test Webhook
+*CollectionsWebhookApi* | [**update_webhook2**](docs/CollectionsWebhookApi.md#update_webhook2) | **PUT** /v1/collections/webhooks/{id} | Update Webhook
+*ContactApi* | [**contact_sales**](docs/ContactApi.md#contact_sales) | **POST** /v1/contact/sales | Contact Sales
+*ConversationWebhookApi* | [**create_webhook1**](docs/ConversationWebhookApi.md#create_webhook1) | **POST** /v1/conversations/webhooks | Create Webhook
+*ConversationWebhookApi* | [**delete_webhook1**](docs/ConversationWebhookApi.md#delete_webhook1) | **DELETE** /v1/conversations/webhooks/{id} | Delete Webhook
+*ConversationWebhookApi* | [**get_webhook1**](docs/ConversationWebhookApi.md#get_webhook1) | **GET** /v1/conversations/webhooks/{id} | Get Webhook
+*ConversationWebhookApi* | [**list_webhooks1**](docs/ConversationWebhookApi.md#list_webhooks1) | **GET** /v1/conversations/webhooks | List Webhooks
+*ConversationWebhookApi* | [**test_webhook1**](docs/ConversationWebhookApi.md#test_webhook1) | **POST** /v1/conversations/webhooks/{id}/test | Test Webhook
+*ConversationWebhookApi* | [**update_webhook1**](docs/ConversationWebhookApi.md#update_webhook1) | **PUT** /v1/conversations/webhooks/{id} | Update Webhook
+*DevStripeCustomerApi* | [**get_my_stripe_customer_ids**](docs/DevStripeCustomerApi.md#get_my_stripe_customer_ids) | **GET** /v1/test/customer-id | Get My Stripe Customer Ids
+*EncryptedFileApi* | [**download_encrypted_file**](docs/EncryptedFileApi.md#download_encrypted_file) | **GET** /v1/files/encrypted/{fileId} | Download Encrypted File
+*EncryptedFileApi* | [**download_encrypted_file_by_query**](docs/EncryptedFileApi.md#download_encrypted_file_by_query) | **GET** /v1/files/encrypted | Download Encrypted File By Query
+*EncryptedFileApi* | [**upload_encrypted_file**](docs/EncryptedFileApi.md#upload_encrypted_file) | **POST** /v1/files/encrypted | Upload Encrypted File
+*GlobalSearchApi* | [**search**](docs/GlobalSearchApi.md#search) | **GET** /v1/search/global | Search
+*LibraryApi* | [**add_share**](docs/LibraryApi.md#add_share) | **POST** /v1/collections/{collectionId}/shares | Add Share
+*LibraryApi* | [**archive_collection**](docs/LibraryApi.md#archive_collection) | **POST** /v1/collections/{collectionId}/archive | Archive Collection
+*LibraryApi* | [**create_collection**](docs/LibraryApi.md#create_collection) | **POST** /v1/collections | Create Collection
+*LibraryApi* | [**delete_collection**](docs/LibraryApi.md#delete_collection) | **DELETE** /v1/collections/{collectionId} | Delete Collection
+*LibraryApi* | [**delete_file**](docs/LibraryApi.md#delete_file) | **DELETE** /v1/collections/{collectionId}/files/{fileId} | Delete File
+*LibraryApi* | [**get_collection**](docs/LibraryApi.md#get_collection) | **GET** /v1/collections/{collectionId} | Get Collection
+*LibraryApi* | [**list_collections**](docs/LibraryApi.md#list_collections) | **GET** /v1/collections | List Collections
+*LibraryApi* | [**remove_share**](docs/LibraryApi.md#remove_share) | **DELETE** /v1/collections/{collectionId}/shares/{shareId} | Remove Share
+*LibraryApi* | [**search_files**](docs/LibraryApi.md#search_files) | **GET** /v1/library/files | Search Files
+*LibraryApi* | [**unarchive_collection**](docs/LibraryApi.md#unarchive_collection) | **DELETE** /v1/collections/{collectionId}/archive | Unarchive Collection
+*LibraryApi* | [**update_collection**](docs/LibraryApi.md#update_collection) | **PATCH** /v1/collections/{collectionId} | Update Collection
+*LibraryApi* | [**upload_file**](docs/LibraryApi.md#upload_file) | **POST** /v1/collections/{collectionId}/files | Upload File
+*MembershipApi* | [**accept_membership_invitation**](docs/MembershipApi.md#accept_membership_invitation) | **POST** /v1/sign/memberships/{membershipId}/accept | Accept Membership Invitation
+*MembershipApi* | [**change_membership_role**](docs/MembershipApi.md#change_membership_role) | **PATCH** /v1/sign/memberships/{membershipId}/role | Change Membership Role
+*MembershipApi* | [**create_membership**](docs/MembershipApi.md#create_membership) | **POST** /v1/sign/memberships | Create Membership
+*MembershipApi* | [**decline_membership_invitation**](docs/MembershipApi.md#decline_membership_invitation) | **POST** /v1/sign/memberships/{membershipId}/decline | Decline Membership Invitation
+*MembershipApi* | [**get_all_memberships**](docs/MembershipApi.md#get_all_memberships) | **GET** /v1/sign/memberships | Get All Memberships
+*MembershipApi* | [**get_membership_by_id**](docs/MembershipApi.md#get_membership_by_id) | **GET** /v1/sign/memberships/{membershipId} | Get Membership By Id
+*MembershipApi* | [**leave_membership**](docs/MembershipApi.md#leave_membership) | **DELETE** /v1/sign/memberships/{membershipId} | Leave Membership
+*MessageApi* | [**add_message_to_channel**](docs/MessageApi.md#add_message_to_channel) | **POST** /v1/conversations/channel/{channelId} | Add Message To Channel
+*MessageApi* | [**archive_channel**](docs/MessageApi.md#archive_channel) | **POST** /v1/conversations/channel/{channelId}/archive | Archive Channel
+*MessageApi* | [**cancel_agent_reply**](docs/MessageApi.md#cancel_agent_reply) | **POST** /v1/conversations/channel/{channelId}/agent/cancel | Cancel Agent Reply
+*MessageApi* | [**create_channel**](docs/MessageApi.md#create_channel) | **POST** /v1/conversations/channel | Create Channel
+*MessageApi* | [**delete_channel**](docs/MessageApi.md#delete_channel) | **DELETE** /v1/conversations/channel/{channelId} | Delete Channel
+*MessageApi* | [**delete_channel_message**](docs/MessageApi.md#delete_channel_message) | **DELETE** /v1/conversations/channel/{channelId}/message/{messageId} | Delete Channel Message
+*MessageApi* | [**delete_private_note**](docs/MessageApi.md#delete_private_note) | **DELETE** /v1/conversations/channel/{channelId}/private-note | Delete Private Note
+*MessageApi* | [**get_channel**](docs/MessageApi.md#get_channel) | **GET** /v1/conversations/channel/{channelId} | Get Channel
+*MessageApi* | [**get_preferences**](docs/MessageApi.md#get_preferences) | **GET** /v1/conversations/preferences | Get Preferences
+*MessageApi* | [**get_private_note**](docs/MessageApi.md#get_private_note) | **GET** /v1/conversations/channel/{channelId}/private-note | Get Private Note
+*MessageApi* | [**leave_channel**](docs/MessageApi.md#leave_channel) | **DELETE** /v1/conversations/channel/{channelId}/leave | Leave Channel
+*MessageApi* | [**list_channel_threads**](docs/MessageApi.md#list_channel_threads) | **GET** /v1/conversations/channel/{channelId}/threads | List Channel Threads
+*MessageApi* | [**list_channels**](docs/MessageApi.md#list_channels) | **GET** /v1/conversations/channel | List Channels
+*MessageApi* | [**list_threads**](docs/MessageApi.md#list_threads) | **GET** /v1/conversations | List Threads
+*MessageApi* | [**mute_channel**](docs/MessageApi.md#mute_channel) | **POST** /v1/conversations/channel/{channelId}/muted | Mute Channel
+*MessageApi* | [**sync_channel_keys**](docs/MessageApi.md#sync_channel_keys) | **POST** /v1/conversations/channel/{channelId}/keys | Sync Channel Keys
+*MessageApi* | [**toggle_channel_message_reaction**](docs/MessageApi.md#toggle_channel_message_reaction) | **POST** /v1/conversations/channel/{channelId}/message/{messageId}/reaction | Toggle Channel Message Reaction
+*MessageApi* | [**unarchive_channel**](docs/MessageApi.md#unarchive_channel) | **DELETE** /v1/conversations/channel/{channelId}/archive | Unarchive Channel
+*MessageApi* | [**unmute_channel**](docs/MessageApi.md#unmute_channel) | **DELETE** /v1/conversations/channel/{channelId}/muted | Unmute Channel
+*MessageApi* | [**update_channel**](docs/MessageApi.md#update_channel) | **PUT** /v1/conversations/channel/{channelId} | Update Channel
+*MessageApi* | [**update_channel_message**](docs/MessageApi.md#update_channel_message) | **PUT** /v1/conversations/channel/{channelId}/message/{messageId} | Update Channel Message
+*MessageApi* | [**upsert_private_note**](docs/MessageApi.md#upsert_private_note) | **PUT** /v1/conversations/channel/{channelId}/private-note | Upsert Private Note
+*NotificationApi* | [**clear_read**](docs/NotificationApi.md#clear_read) | **POST** /v1/sign/notifications/clear-read | Clear Read
+*NotificationApi* | [**delete_notification**](docs/NotificationApi.md#delete_notification) | **DELETE** /v1/sign/notifications/{id} | Delete Notification
+*NotificationApi* | [**list_notifications**](docs/NotificationApi.md#list_notifications) | **GET** /v1/sign/notifications | List Notifications
+*NotificationApi* | [**mark_all_read**](docs/NotificationApi.md#mark_all_read) | **POST** /v1/sign/notifications/read-all | Mark All Read
+*NotificationApi* | [**mark_read**](docs/NotificationApi.md#mark_read) | **POST** /v1/sign/notifications/{id}/read | Mark Read
+*NotificationApi* | [**mark_unread**](docs/NotificationApi.md#mark_unread) | **POST** /v1/sign/notifications/{id}/unread | Mark Unread
+*NotificationApi* | [**register_push_device**](docs/NotificationApi.md#register_push_device) | **POST** /v1/sign/notifications/push/devices | Register Push Device
+*NotificationApi* | [**unread_count**](docs/NotificationApi.md#unread_count) | **GET** /v1/sign/notifications/unread-count | Unread Count
+*NotificationApi* | [**unregister_push_device**](docs/NotificationApi.md#unregister_push_device) | **DELETE** /v1/sign/notifications/push/devices/{deviceId} | Unregister Push Device
+*ProfileApi* | [**add_or_increment_subscription_item**](docs/ProfileApi.md#add_or_increment_subscription_item) | **POST** /v1/sign/profile/subscription-items | Add Or Increment Subscription Item
+*ProfileApi* | [**cancel_scheduled_change**](docs/ProfileApi.md#cancel_scheduled_change) | **POST** /v1/sign/profile/cancel-scheduled-change | Cancel Scheduled Change
+*ProfileApi* | [**create_api_key**](docs/ProfileApi.md#create_api_key) | **POST** /v1/sign/profile/apikeys | Create Api Key
+*ProfileApi* | [**delete_account**](docs/ProfileApi.md#delete_account) | **DELETE** /v1/sign/profile | Delete Account
+*ProfileApi* | [**delete_api_key**](docs/ProfileApi.md#delete_api_key) | **DELETE** /v1/sign/profile/apikeys/{apiKeyId} | Delete Api Key
+*ProfileApi* | [**downgrade_to_free**](docs/ProfileApi.md#downgrade_to_free) | **POST** /v1/sign/profile/downgrade-to-free | Downgrade To Free
+*ProfileApi* | [**get_billing_usage_summary**](docs/ProfileApi.md#get_billing_usage_summary) | **GET** /v1/sign/profile/billing-usage-summary | Get Billing Usage Summary
+*ProfileApi* | [**get_profile**](docs/ProfileApi.md#get_profile) | **GET** /v1/sign/profile | Get Profile
+*ProfileApi* | [**get_public_profile_by_email**](docs/ProfileApi.md#get_public_profile_by_email) | **GET** /v1/sign/profile/public | Get Public Profile By Email
+*ProfileApi* | [**get_public_profile_by_id**](docs/ProfileApi.md#get_public_profile_by_id) | **GET** /v1/sign/profile/public/{profileId} | Get Public Profile By Id
+*ProfileApi* | [**get_user_keys**](docs/ProfileApi.md#get_user_keys) | **GET** /v1/sign/profile/keys | Get User Keys
+*ProfileApi* | [**list_api_keys**](docs/ProfileApi.md#list_api_keys) | **GET** /v1/sign/profile/apikeys | List Api Keys
+*ProfileApi* | [**list_credit_usage**](docs/ProfileApi.md#list_credit_usage) | **GET** /v1/sign/profile/credit-usage | List Credit Usage
+*ProfileApi* | [**list_subscription_items**](docs/ProfileApi.md#list_subscription_items) | **GET** /v1/sign/profile/subscription-items | List Subscription Items
+*ProfileApi* | [**list_trusted_devices**](docs/ProfileApi.md#list_trusted_devices) | **GET** /v1/sign/profile/devices | List Trusted Devices
+*ProfileApi* | [**logout_other_devices**](docs/ProfileApi.md#logout_other_devices) | **POST** /v1/sign/profile/logout-other-devices | Logout Other Devices
+*ProfileApi* | [**register_trusted_device**](docs/ProfileApi.md#register_trusted_device) | **POST** /v1/sign/profile/devices/register | Register Trusted Device
+*ProfileApi* | [**remove_subscription_item**](docs/ProfileApi.md#remove_subscription_item) | **DELETE** /v1/sign/profile/subscription-items | Remove Subscription Item
+*ProfileApi* | [**revoke_other_trusted_devices**](docs/ProfileApi.md#revoke_other_trusted_devices) | **POST** /v1/sign/profile/devices/revoke-others | Revoke Other Trusted Devices
+*ProfileApi* | [**revoke_trusted_device**](docs/ProfileApi.md#revoke_trusted_device) | **POST** /v1/sign/profile/devices/revoke | Revoke Trusted Device
+*ProfileApi* | [**schedule_plan_downgrade**](docs/ProfileApi.md#schedule_plan_downgrade) | **POST** /v1/sign/profile/schedule-downgrade | Schedule Plan Downgrade
+*ProfileApi* | [**search_public_profiles**](docs/ProfileApi.md#search_public_profiles) | **GET** /v1/sign/profile/public/search | Search Public Profiles
+*ProfileApi* | [**start_billing_portal**](docs/ProfileApi.md#start_billing_portal) | **POST** /v1/sign/profile/billing-portal | Start Billing Portal
+*ProfileApi* | [**start_checkout**](docs/ProfileApi.md#start_checkout) | **POST** /v1/sign/profile/checkout | Start Checkout
+*ProfileApi* | [**update_profile**](docs/ProfileApi.md#update_profile) | **PUT** /v1/sign/profile | Update Profile
+*ProfileApi* | [**update_user_keys**](docs/ProfileApi.md#update_user_keys) | **PUT** /v1/sign/profile/keys | Update User Keys
+*PublicAssistantApi* | [**chat**](docs/PublicAssistantApi.md#chat) | **POST** /v1/public-assistant/chat | Chat
+*SignatureCardApi* | [**create**](docs/SignatureCardApi.md#create) | **POST** /v1/sign/signature-cards | Create
+*SignatureCardApi* | [**delete**](docs/SignatureCardApi.md#delete) | **DELETE** /v1/sign/signature-cards/{id} | Delete
+*SignatureCardApi* | [**get**](docs/SignatureCardApi.md#get) | **GET** /v1/sign/signature-cards/{id} | Get
+*SignatureCardApi* | [**get_default**](docs/SignatureCardApi.md#get_default) | **GET** /v1/sign/signature-cards/default | Get Default
+*SignatureCardApi* | [**list**](docs/SignatureCardApi.md#list) | **GET** /v1/sign/signature-cards | List
+*SignatureCardApi* | [**set_default**](docs/SignatureCardApi.md#set_default) | **POST** /v1/sign/signature-cards/{id}/default | Set Default
+*SignatureCardApi* | [**update**](docs/SignatureCardApi.md#update) | **PUT** /v1/sign/signature-cards/{id} | Update
+*SignatureManagementApi* | [**add_signature**](docs/SignatureManagementApi.md#add_signature) | **POST** /v1/sign/signatures | Add Signature
+*SignatureManagementApi* | [**delete_signature**](docs/SignatureManagementApi.md#delete_signature) | **DELETE** /v1/sign/signatures/{signatureId} | Delete Signature
+*SignatureManagementApi* | [**get_default_signature**](docs/SignatureManagementApi.md#get_default_signature) | **GET** /v1/sign/signatures/default | Get Default Signature
+*SignatureManagementApi* | [**get_signatures**](docs/SignatureManagementApi.md#get_signatures) | **GET** /v1/sign/signatures | Get Signatures
+*SignatureManagementApi* | [**set_default_signature**](docs/SignatureManagementApi.md#set_default_signature) | **PUT** /v1/sign/signatures/{signatureId}/default | Set Default Signature
+*SigncardTemplateApi* | [**create_template**](docs/SigncardTemplateApi.md#create_template) | **POST** /v1/sign/templates | Create Template
+*SigncardTemplateApi* | [**delete_template**](docs/SigncardTemplateApi.md#delete_template) | **DELETE** /v1/sign/templates/{id} | Delete Template
+*SigncardTemplateApi* | [**get_template_by_id**](docs/SigncardTemplateApi.md#get_template_by_id) | **GET** /v1/sign/templates/{id} | Get Template By Id
+*SigncardTemplateApi* | [**get_templates**](docs/SigncardTemplateApi.md#get_templates) | **GET** /v1/sign/templates | Get Templates
+*SigningApi* | [**get_signing_status**](docs/SigningApi.md#get_signing_status) | **GET** /v1/sign/signing/{processId}/status | Get Signing Status
+*SigningApi* | [**resend_otp**](docs/SigningApi.md#resend_otp) | **POST** /v1/sign/signing/otp/resend | Resend Otp
+*SigningApi* | [**sign**](docs/SigningApi.md#sign) | **POST** /v1/sign/signing/request/{processId} | Sign
+*SigningApi* | [**sign_hash**](docs/SigningApi.md#sign_hash) | **POST** /v1/sign/signing-hash/request | Sign Hash
+*SigningApi* | [**submit_otp**](docs/SigningApi.md#submit_otp) | **POST** /v1/sign/signing/otp | Submit Otp
+*SigningApi* | [**upload_signed_documents**](docs/SigningApi.md#upload_signed_documents) | **POST** /v1/sign/signing/upload/{processId} | Upload Signed Documents
+*SigningProcessApi* | [**approve_review**](docs/SigningProcessApi.md#approve_review) | **POST** /v1/sign/signing-process/{id}/reviews/approve | Approve Review
+*SigningProcessApi* | [**archive_signing_process**](docs/SigningProcessApi.md#archive_signing_process) | **POST** /v1/sign/signing-process/{id}/archive | Archive Signing Process
+*SigningProcessApi* | [**create_signing_process**](docs/SigningProcessApi.md#create_signing_process) | **POST** /v1/sign/signing-process | Create Signing Process
+*SigningProcessApi* | [**decline_participation**](docs/SigningProcessApi.md#decline_participation) | **POST** /v1/sign/signing-process/{id}/participants/decline | Decline Participation
+*SigningProcessApi* | [**delete_signing_process**](docs/SigningProcessApi.md#delete_signing_process) | **DELETE** /v1/sign/signing-process/{id} | Delete Signing Process
+*SigningProcessApi* | [**get_pending_ceks**](docs/SigningProcessApi.md#get_pending_ceks) | **GET** /v1/sign/signing-process/{id}/pending-ceks | Get Pending Ceks
+*SigningProcessApi* | [**get_self_cek**](docs/SigningProcessApi.md#get_self_cek) | **GET** /v1/sign/signing-process/{id}/ceks/self | Get Self Cek
+*SigningProcessApi* | [**get_signing_process**](docs/SigningProcessApi.md#get_signing_process) | **GET** /v1/sign/signing-process/{id} | Get Signing Process
+*SigningProcessApi* | [**list_cek_public_keys**](docs/SigningProcessApi.md#list_cek_public_keys) | **GET** /v1/sign/signing-process/{id}/ceks/public-keys | List Cek Public Keys
+*SigningProcessApi* | [**list_signing_processes**](docs/SigningProcessApi.md#list_signing_processes) | **GET** /v1/sign/signing-process | List Signing Processes
+*SigningProcessApi* | [**reject_review**](docs/SigningProcessApi.md#reject_review) | **POST** /v1/sign/signing-process/{id}/reviews/reject | Reject Review
+*SigningProcessApi* | [**resend_participant_invitation**](docs/SigningProcessApi.md#resend_participant_invitation) | **POST** /v1/sign/signing-process/{id}/participants/resend | Resend Participant Invitation
+*SigningProcessApi* | [**rotate_passphrase**](docs/SigningProcessApi.md#rotate_passphrase) | **POST** /v1/sign/signing-process/{id}/rotate-passphrase | Rotate Passphrase
+*SigningProcessApi* | [**unarchive_signing_process**](docs/SigningProcessApi.md#unarchive_signing_process) | **DELETE** /v1/sign/signing-process/{id}/archive | Unarchive Signing Process
+*SigningProcessApi* | [**update_ceks**](docs/SigningProcessApi.md#update_ceks) | **POST** /v1/sign/signing-process/{id}/ceks | Update Ceks
+*SigningProcessApi* | [**update_self_cek**](docs/SigningProcessApi.md#update_self_cek) | **POST** /v1/sign/signing-process/{id}/ceks/self | Update Self Cek
+*SigningProcessApi* | [**update_signing_process**](docs/SigningProcessApi.md#update_signing_process) | **PUT** /v1/sign/signing-process/{id} | Update Signing Process
+*SigningProcessApi* | [**withdraw_signing_process**](docs/SigningProcessApi.md#withdraw_signing_process) | **POST** /v1/sign/signing-process/{id}/withdraw | Withdraw Signing Process
+*SigningProcessTemplateApi* | [**create_template1**](docs/SigningProcessTemplateApi.md#create_template1) | **POST** /v1/sign/signing-process-templates | Create Template
+*SigningProcessTemplateApi* | [**delete_template1**](docs/SigningProcessTemplateApi.md#delete_template1) | **DELETE** /v1/sign/signing-process-templates/{id} | Delete Template
+*SigningProcessTemplateApi* | [**get_template**](docs/SigningProcessTemplateApi.md#get_template) | **GET** /v1/sign/signing-process-templates/{id} | Get Template
+*SigningProcessTemplateApi* | [**list_templates**](docs/SigningProcessTemplateApi.md#list_templates) | **GET** /v1/sign/signing-process-templates | List Templates
+*SigningProcessTemplateApi* | [**update_template**](docs/SigningProcessTemplateApi.md#update_template) | **PUT** /v1/sign/signing-process-templates/{id} | Update Template
+*StripeWebhookApi* | [**handle**](docs/StripeWebhookApi.md#handle) | **POST** /v1/stripe/webhook | Handle
+*TestDataCleanupApi* | [**apply_due_downgrades**](docs/TestDataCleanupApi.md#apply_due_downgrades) | **POST** /v1/test/apply-due-downgrades | Apply Due Downgrades
+*TestDataCleanupApi* | [**clear_test_data**](docs/TestDataCleanupApi.md#clear_test_data) | **POST** /v1/test/clear-data | Clear Test Data
+*WebhookApi* | [**create_webhook**](docs/WebhookApi.md#create_webhook) | **POST** /v1/sign/webhooks | Create Webhook
+*WebhookApi* | [**delete_webhook**](docs/WebhookApi.md#delete_webhook) | **DELETE** /v1/sign/webhooks/{id} | Delete Webhook
+*WebhookApi* | [**get_webhook**](docs/WebhookApi.md#get_webhook) | **GET** /v1/sign/webhooks/{id} | Get Webhook
+*WebhookApi* | [**list_webhooks**](docs/WebhookApi.md#list_webhooks) | **GET** /v1/sign/webhooks | List Webhooks
+*WebhookApi* | [**test_webhook**](docs/WebhookApi.md#test_webhook) | **POST** /v1/sign/webhooks/{id}/test | Test Webhook
+*WebhookApi* | [**update_webhook**](docs/WebhookApi.md#update_webhook) | **PUT** /v1/sign/webhooks/{id} | Update Webhook
+
+
+## Documentation For Models
+
+ - [APIKeyPublicView](docs/APIKeyPublicView.md)
+ - [AddOnSubscriptionItemView](docs/AddOnSubscriptionItemView.md)
+ - [AgentCommandResponse](docs/AgentCommandResponse.md)
+ - [AgentDeviceSummaryResponse](docs/AgentDeviceSummaryResponse.md)
+ - [AgentLibraryFileMatchResponse](docs/AgentLibraryFileMatchResponse.md)
+ - [AgentLibraryFileSearchResponse](docs/AgentLibraryFileSearchResponse.md)
+ - [ApiProblem](docs/ApiProblem.md)
+ - [ApiProblemErrorsInner](docs/ApiProblemErrorsInner.md)
+ - [AppConfigResponse](docs/AppConfigResponse.md)
+ - [AuditLogEntryResponse](docs/AuditLogEntryResponse.md)
+ - [BillingUsageMetricResponse](docs/BillingUsageMetricResponse.md)
+ - [BillingUsageSectionResponse](docs/BillingUsageSectionResponse.md)
+ - [BillingUsageSummaryResponse](docs/BillingUsageSummaryResponse.md)
+ - [ChangeMembershipRoleRequest](docs/ChangeMembershipRoleRequest.md)
+ - [CheckProps](docs/CheckProps.md)
+ - [CollectionQuotaResponse](docs/CollectionQuotaResponse.md)
+ - [ConfirmAgentPairingRequest](docs/ConfirmAgentPairingRequest.md)
+ - [ConversationQuotaResponse](docs/ConversationQuotaResponse.md)
+ - [ConversationThreadPreferencesResponse](docs/ConversationThreadPreferencesResponse.md)
+ - [CreateAPIKeyRequest](docs/CreateAPIKeyRequest.md)
+ - [CreateAPIKeyResponse](docs/CreateAPIKeyResponse.md)
+ - [CreateAgentCommandRequest](docs/CreateAgentCommandRequest.md)
+ - [CreateEncryptedMessageRequest](docs/CreateEncryptedMessageRequest.md)
+ - [CreateLibraryCollectionRequest](docs/CreateLibraryCollectionRequest.md)
+ - [CreateLibraryShareRequest](docs/CreateLibraryShareRequest.md)
+ - [CreateMessageThreadRequest](docs/CreateMessageThreadRequest.md)
+ - [CreateSignatureRequest](docs/CreateSignatureRequest.md)
+ - [CreateSigningProcessRequest](docs/CreateSigningProcessRequest.md)
+ - [CreateSigningProcessResponse](docs/CreateSigningProcessResponse.md)
+ - [CreateSigningProcessTemplateRequest](docs/CreateSigningProcessTemplateRequest.md)
+ - [CreateWebhookRequest](docs/CreateWebhookRequest.md)
+ - [CreditUsageEntryResponse](docs/CreditUsageEntryResponse.md)
+ - [CreditUsagePageResponse](docs/CreditUsagePageResponse.md)
+ - [DateProps](docs/DateProps.md)
+ - [DeclineParticipationRequest](docs/DeclineParticipationRequest.md)
+ - [DocumentHash](docs/DocumentHash.md)
+ - [DropdownProps](docs/DropdownProps.md)
+ - [EncryptedAssetRequest](docs/EncryptedAssetRequest.md)
+ - [EncryptedAssetResponse](docs/EncryptedAssetResponse.md)
+ - [EncryptedFileUploadResponse](docs/EncryptedFileUploadResponse.md)
+ - [EncryptedMessageResponse](docs/EncryptedMessageResponse.md)
+ - [FormField](docs/FormField.md)
+ - [GetSigningProcessResponse](docs/GetSigningProcessResponse.md)
+ - [GetSigningProcessTemplateResponse](docs/GetSigningProcessTemplateResponse.md)
+ - [GlobalSearchChannelResponse](docs/GlobalSearchChannelResponse.md)
+ - [GlobalSearchFileResponse](docs/GlobalSearchFileResponse.md)
+ - [GlobalSearchPersonResponse](docs/GlobalSearchPersonResponse.md)
+ - [GlobalSearchRequestResponse](docs/GlobalSearchRequestResponse.md)
+ - [GlobalSearchResponse](docs/GlobalSearchResponse.md)
+ - [LibraryCollectionFileResponse](docs/LibraryCollectionFileResponse.md)
+ - [LibraryCollectionResponse](docs/LibraryCollectionResponse.md)
+ - [LibraryCollectionShareResponse](docs/LibraryCollectionShareResponse.md)
+ - [LibraryCollectionSummaryResponse](docs/LibraryCollectionSummaryResponse.md)
+ - [LoginRequest](docs/LoginRequest.md)
+ - [LoginResponse](docs/LoginResponse.md)
+ - [MemberShipInvitationRequest](docs/MemberShipInvitationRequest.md)
+ - [Membership](docs/Membership.md)
+ - [MessageChannelRefResponse](docs/MessageChannelRefResponse.md)
+ - [MessageMentionResponse](docs/MessageMentionResponse.md)
+ - [MessageReactionResponse](docs/MessageReactionResponse.md)
+ - [MessageThreadResponse](docs/MessageThreadResponse.md)
+ - [MessageThreadSummaryResponse](docs/MessageThreadSummaryResponse.md)
+ - [NotificationListResponse](docs/NotificationListResponse.md)
+ - [NotificationResponse](docs/NotificationResponse.md)
+ - [NotificationUnreadCountResponse](docs/NotificationUnreadCountResponse.md)
+ - [Observer](docs/Observer.md)
+ - [OtpDetail](docs/OtpDetail.md)
+ - [PairingStatusResponse](docs/PairingStatusResponse.md)
+ - [PendingCekResponse](docs/PendingCekResponse.md)
+ - [ProcessUpdateRequest](docs/ProcessUpdateRequest.md)
+ - [Profile](docs/Profile.md)
+ - [PublicAssistantCitationResponse](docs/PublicAssistantCitationResponse.md)
+ - [PublicAssistantLinkResponse](docs/PublicAssistantLinkResponse.md)
+ - [PublicAssistantRequest](docs/PublicAssistantRequest.md)
+ - [PublicAssistantResponse](docs/PublicAssistantResponse.md)
+ - [PublicKey](docs/PublicKey.md)
+ - [PublicProfileResponse](docs/PublicProfileResponse.md)
+ - [ReactToMessageRequest](docs/ReactToMessageRequest.md)
+ - [RegisterPushDeviceRequest](docs/RegisterPushDeviceRequest.md)
+ - [RegisterTrustedDeviceRequest](docs/RegisterTrustedDeviceRequest.md)
+ - [RequestAgentPairingRequest](docs/RequestAgentPairingRequest.md)
+ - [RequestAgentPairingResponse](docs/RequestAgentPairingResponse.md)
+ - [ResendInvitationRequest](docs/ResendInvitationRequest.md)
+ - [ResendOtpRequest](docs/ResendOtpRequest.md)
+ - [ReviewRejectionRequest](docs/ReviewRejectionRequest.md)
+ - [Reviewer](docs/Reviewer.md)
+ - [RevokeTrustedDeviceRequest](docs/RevokeTrustedDeviceRequest.md)
+ - [RotatePassphraseRequest](docs/RotatePassphraseRequest.md)
+ - [SalesContactRequest](docs/SalesContactRequest.md)
+ - [SelfCekResponse](docs/SelfCekResponse.md)
+ - [SignatureCard](docs/SignatureCard.md)
+ - [SignatureImage](docs/SignatureImage.md)
+ - [SignatureProps](docs/SignatureProps.md)
+ - [SigncardTemplate](docs/SigncardTemplate.md)
+ - [Signer](docs/Signer.md)
+ - [SigningDocument](docs/SigningDocument.md)
+ - [SigningDocumentResponse](docs/SigningDocumentResponse.md)
+ - [SigningHashRequest](docs/SigningHashRequest.md)
+ - [SigningRequest](docs/SigningRequest.md)
+ - [SigningResponse](docs/SigningResponse.md)
+ - [SigningStatusResponse](docs/SigningStatusResponse.md)
+ - [SigningUploadResponse](docs/SigningUploadResponse.md)
+ - [SimpleActionResponse](docs/SimpleActionResponse.md)
+ - [SubmitOtpRequest](docs/SubmitOtpRequest.md)
+ - [SyncThreadKeysRequest](docs/SyncThreadKeysRequest.md)
+ - [SyncThreadKeysResponse](docs/SyncThreadKeysResponse.md)
+ - [TestDataCleanupResponse](docs/TestDataCleanupResponse.md)
+ - [TextProps](docs/TextProps.md)
+ - [ThreadParticipantKeyRequest](docs/ThreadParticipantKeyRequest.md)
+ - [ThreadPrivateNoteResponse](docs/ThreadPrivateNoteResponse.md)
+ - [TrustedDeviceResponse](docs/TrustedDeviceResponse.md)
+ - [UpdateCekRequest](docs/UpdateCekRequest.md)
+ - [UpdateDocumentRequest](docs/UpdateDocumentRequest.md)
+ - [UpdateEncryptedMessageRequest](docs/UpdateEncryptedMessageRequest.md)
+ - [UpdateLibraryCollectionRequest](docs/UpdateLibraryCollectionRequest.md)
+ - [UpdateMessageThreadRequest](docs/UpdateMessageThreadRequest.md)
+ - [UpdateSelfCekRequest](docs/UpdateSelfCekRequest.md)
+ - [UpdateThreadPrivateNoteRequest](docs/UpdateThreadPrivateNoteRequest.md)
+ - [UpdateUserKeysRequest](docs/UpdateUserKeysRequest.md)
+ - [UpdateUserProfileRequest](docs/UpdateUserProfileRequest.md)
+ - [UpdateWebhookRequest](docs/UpdateWebhookRequest.md)
+ - [UpsertAgentKeyGrantRequest](docs/UpsertAgentKeyGrantRequest.md)
+ - [WebhookEndpointResponse](docs/WebhookEndpointResponse.md)
+ - [WebhookSecretResponse](docs/WebhookSecretResponse.md)
+ - [WebhookTestResponse](docs/WebhookTestResponse.md)
+
+
+<a id="documentation-for-authorization"></a>
+## Documentation For Authorization
+
+
+Authentication schemes defined for the API:
+<a id="bearerAuth"></a>
+### bearerAuth
+
+- **Type**: Bearer authentication (JWT)
+
+<a id="apiKeyAuth"></a>
+### apiKeyAuth
+
+- **Type**: API key
+- **API key parameter name**: X-API-KEY
+- **Location**: HTTP header
+
+
+## Author
+
+
+