relaya-sdk-python 0.1.1

Relaya MAX API Python SDK

Relaya Python SDK

API for Relaya integrations and management

This Python package is automatically generated by the OpenAPI Generator project:

• API version: (devel)
• Package version: 0.1.1
• Generator version: 7.20.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.9+

Installation & Usage

pip install

Install from PyPI:

pip install relaya-sdk-python

Then import the package:

import relaya_sdk

Setuptools

Install via Setuptools.

python -m pip install .

Then import the package:

import relaya_sdk

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import relaya_sdk
from relaya_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.relaya.ru/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = relaya_sdk.Configuration(
    host = "https://api.relaya.ru/v1"
)

# 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 Bearer authorization (JWT): BearerAuth
configuration = relaya_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


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

    try:
        # List account modules
        api_response = api_instance.get_account_modules()
        print("The response of AccountApi->get_account_modules:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AccountApi->get_account_modules: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api.relaya.ru/v1

Class	Method	HTTP request	Description
AccountApi	get_account_modules	GET /account/modules	List account modules
AccountApi	get_account_modules_usage	GET /account/modules/usage	Get account module usage
AccountApi	put_account_modules_module_code	PUT /account/modules/{moduleCode}	Update account module
AuthApi	auth_oauth_provider_callback_get	GET /auth/oauth/{provider}/callback	OAuth callback
AuthApi	auth_oauth_telegram_complete_post	POST /auth/oauth/telegram/complete	OAuth Telegram complete
AuthApi	get_auth_oauth_provider_start	GET /auth/oauth/{provider}/start	Start OAuth authorization
AuthApi	get_auth_oauth_providers	GET /auth/oauth/providers	Get OAuth providers availability
AuthApi	get_profiles_profile_id_integrations_integration_auth_qr	GET /profiles/{profileId}/integrations/{integration}/auth/qr	Get auth QR
AuthApi	get_profiles_profile_id_integrations_integration_auth_qr_status	GET /profiles/{profileId}/integrations/{integration}/auth/qr/status	Get QR auth status
AuthApi	get_profiles_profile_id_integrations_integration_token	GET /profiles/{profileId}/integrations/{integration}/token	Get bot token
AuthApi	get_users_exists	GET /users/exists	Check if user exists
AuthApi	post_auth_email_verify_confirm	POST /auth/email/verify/confirm	Confirm email verification
AuthApi	post_auth_email_verify_request	POST /auth/email/verify/request	Request email verification code
AuthApi	post_auth_oauth_pending_complete_email	POST /auth/oauth/pending/complete-email	Complete OAuth with email
AuthApi	post_auth_phone_telegram_confirm	POST /auth/phone/telegram/confirm	Confirm Telegram phone verification
AuthApi	post_auth_phone_telegram_start	POST /auth/phone/telegram/start	Start Telegram phone verification
AuthApi	post_auth_tokens	POST /auth/tokens	Create authentication token
AuthApi	post_profiles_profile_id_integrations_integration_auth2fa	POST /profiles/{profileId}/integrations/{integration}/auth/2fa	Submit 2FA password
AuthApi	post_profiles_profile_id_integrations_integration_auth_logout	POST /profiles/{profileId}/integrations/{integration}/auth/logout	Logout profile
AuthApi	post_profiles_profile_id_integrations_integration_auth_phone_code	POST /profiles/{profileId}/integrations/{integration}/auth/phone/code	Confirm phone auth code
AuthApi	post_profiles_profile_id_integrations_integration_auth_phone_password	POST /profiles/{profileId}/integrations/{integration}/auth/phone/password	Submit phone auth password
AuthApi	post_profiles_profile_id_integrations_integration_auth_phone_start	POST /profiles/{profileId}/integrations/{integration}/auth/phone/start	Start phone auth
AuthApi	post_profiles_profile_id_integrations_integration_auth_sms_poll	POST /profiles/{profileId}/integrations/{integration}/auth/sms/poll	Poll authorization
AuthApi	post_profiles_profile_id_integrations_integration_auth_sms_start	POST /profiles/{profileId}/integrations/{integration}/auth/sms/start	Start SMS authorization
AuthApi	post_profiles_profile_id_integrations_integration_auth_sms_verify	POST /profiles/{profileId}/integrations/{integration}/auth/sms/verify	Send authorization code
AuthApi	post_users	POST /users	Register new user
AuthApi	profiles_profile_id_integrations_integration_oauth_callback_get	GET /profiles/{profileId}/integrations/{integration}/oauth/callback	VK OAuth callback
AuthApi	put_profiles_profile_id_integrations_integration_token	PUT /profiles/{profileId}/integrations/{integration}/token	Set bot token
BillingApi	billing_provider_webhook_post	POST /billing/provider/webhook	Billing provider webhook
BillingApi	get_billing_topups	GET /billing/topups	List top-up intents
BillingApi	get_billing_topups_topup_id	GET /billing/topups/{topupId}	Get top-up status
BillingApi	get_billing_transactions	GET /billing/transactions	List transactions
BillingApi	post_billing_topups	POST /billing/topups	Create top-up intent
BillingApi	post_billing_topups_topup_id_refresh	POST /billing/topups/{topupId}/refresh	Refresh top-up status from provider
ChatsApi	delete_profiles_profile_id_integrations_integration_folders_folder_id	DELETE /profiles/{profileId}/integrations/{integration}/folders/{folderId}	Delete MAX folder
ChatsApi	get_profiles_profile_id_integrations_integration_folders	GET /profiles/{profileId}/integrations/{integration}/folders	List MAX folders
ChatsApi	post_profiles_profile_id_integrations_integration_chats_by_ids	POST /profiles/{profileId}/integrations/{integration}/chats/by-ids	Get chats by IDs
ChatsApi	post_profiles_profile_id_integrations_integration_chats_subscription	POST /profiles/{profileId}/integrations/{integration}/chats/subscription	Subscribe/unsubscribe chat updates
ChatsApi	post_profiles_profile_id_integrations_integration_folders	POST /profiles/{profileId}/integrations/{integration}/folders	Create MAX folder
ChatsApi	put_profiles_profile_id_integrations_integration_folders_order	PUT /profiles/{profileId}/integrations/{integration}/folders/order	Reorder MAX folders
DashboardApi	get_users_me_dashboard_summary	GET /users/me/dashboard-summary	Get dashboard summary
InboxApi	get_profiles_profile_id_integrations_integration_inbox_conversations	GET /profiles/{profileId}/integrations/{integration}/inbox/conversations	List inbox conversations
InboxApi	get_profiles_profile_id_integrations_integration_inbox_messages	GET /profiles/{profileId}/integrations/{integration}/inbox/messages	List inbox messages
InboxApi	get_users_me_inbox_conversations	GET /users/me/inbox/conversations	List omnichannel inbox conversations
InboxApi	get_users_me_inbox_messages	GET /users/me/inbox/messages	List omnichannel inbox messages
InboxApi	post_profiles_profile_id_integrations_integration_inbox_conversations_action	POST /profiles/{profileId}/integrations/{integration}/inbox/conversations/action	Inbox conversation action
InboxApi	post_profiles_profile_id_integrations_integration_inbox_conversations_avatar	POST /profiles/{profileId}/integrations/{integration}/inbox/conversations/avatar	Inbox conversation avatar
InboxApi	post_profiles_profile_id_integrations_integration_inbox_read	POST /profiles/{profileId}/integrations/{integration}/inbox/read	Mark inbox read
InboxApi	post_users_me_inbox_conversations_action	POST /users/me/inbox/conversations/action	Toggle omnichannel conversation action
InboxApi	post_users_me_inbox_conversations_avatar	POST /users/me/inbox/conversations/avatar	Set omnichannel conversation avatar
InboxApi	post_users_me_inbox_conversations_title	POST /users/me/inbox/conversations/title	Set omnichannel conversation title
InboxApi	post_users_me_inbox_read	POST /users/me/inbox/read	Mark omnichannel conversation as read
InboxApi	post_users_me_inbox_send	POST /users/me/inbox/send	Send omnichannel inbox message
IntegrationsApi	delete_profiles_profile_id_integrations_integration_session	DELETE /profiles/{profileId}/integrations/{integration}/session	Clear integration session
IntegrationsApi	get_profiles_profile_id_integrations_integration_auth_qr	GET /profiles/{profileId}/integrations/{integration}/auth/qr	Get auth QR
IntegrationsApi	get_profiles_profile_id_integrations_integration_auth_qr_status	GET /profiles/{profileId}/integrations/{integration}/auth/qr/status	Get QR auth status
IntegrationsApi	get_profiles_profile_id_integrations_integration_inbox_conversations	GET /profiles/{profileId}/integrations/{integration}/inbox/conversations	List inbox conversations
IntegrationsApi	get_profiles_profile_id_integrations_integration_inbox_messages	GET /profiles/{profileId}/integrations/{integration}/inbox/messages	List inbox messages
IntegrationsApi	get_profiles_profile_id_integrations_integration_overview	GET /profiles/{profileId}/integrations/{integration}/overview	Get profile overview
IntegrationsApi	get_profiles_profile_id_integrations_integration_session	GET /profiles/{profileId}/integrations/{integration}/session	Get integration session
IntegrationsApi	get_profiles_profile_id_integrations_integration_session_chats	GET /profiles/{profileId}/integrations/{integration}/session/chats	Get integration chats
IntegrationsApi	get_profiles_profile_id_integrations_integration_status	GET /profiles/{profileId}/integrations/{integration}/status	Get profile status
IntegrationsApi	get_profiles_profile_id_integrations_integration_token	GET /profiles/{profileId}/integrations/{integration}/token	Get bot token
IntegrationsApi	post_profiles_profile_id_integrations_integration_auth2fa	POST /profiles/{profileId}/integrations/{integration}/auth/2fa	Submit 2FA password
IntegrationsApi	post_profiles_profile_id_integrations_integration_auth_logout	POST /profiles/{profileId}/integrations/{integration}/auth/logout	Logout profile
IntegrationsApi	post_profiles_profile_id_integrations_integration_auth_phone_code	POST /profiles/{profileId}/integrations/{integration}/auth/phone/code	Confirm phone auth code
IntegrationsApi	post_profiles_profile_id_integrations_integration_auth_phone_password	POST /profiles/{profileId}/integrations/{integration}/auth/phone/password	Submit phone auth password
IntegrationsApi	post_profiles_profile_id_integrations_integration_auth_phone_start	POST /profiles/{profileId}/integrations/{integration}/auth/phone/start	Start phone auth
IntegrationsApi	post_profiles_profile_id_integrations_integration_inbox_conversations_action	POST /profiles/{profileId}/integrations/{integration}/inbox/conversations/action	Inbox conversation action
IntegrationsApi	post_profiles_profile_id_integrations_integration_inbox_conversations_avatar	POST /profiles/{profileId}/integrations/{integration}/inbox/conversations/avatar	Inbox conversation avatar
IntegrationsApi	post_profiles_profile_id_integrations_integration_inbox_read	POST /profiles/{profileId}/integrations/{integration}/inbox/read	Mark inbox read
IntegrationsApi	post_profiles_profile_id_integrations_integration_messages	POST /profiles/{profileId}/integrations/{integration}/messages	Send message
IntegrationsApi	post_profiles_profile_id_integrations_integration_messages_delete	POST /profiles/{profileId}/integrations/{integration}/messages/delete	Delete message
IntegrationsApi	post_profiles_profile_id_integrations_integration_messages_edit	POST /profiles/{profileId}/integrations/{integration}/messages/edit	Edit message
IntegrationsApi	post_profiles_profile_id_integrations_integration_messages_forward	POST /profiles/{profileId}/integrations/{integration}/messages/forward	Forward message
IntegrationsApi	post_profiles_profile_id_integrations_integration_messages_history	POST /profiles/{profileId}/integrations/{integration}/messages/history	Get chat history
IntegrationsApi	post_profiles_profile_id_integrations_integration_messages_reply	POST /profiles/{profileId}/integrations/{integration}/messages/reply	Reply message
IntegrationsApi	post_profiles_profile_id_integrations_integration_session_events	POST /profiles/{profileId}/integrations/{integration}/session/events	Get integration events
IntegrationsApi	post_profiles_profile_id_integrations_integration_session_start	POST /profiles/{profileId}/integrations/{integration}/session/start	Start integration session
IntegrationsApi	post_profiles_profile_id_integrations_integration_session_stop	POST /profiles/{profileId}/integrations/{integration}/session/stop	Stop integration session
IntegrationsApi	post_profiles_profile_id_integrations_integration_sync	POST /profiles/{profileId}/integrations/{integration}/sync	Sync integration profile
IntegrationsApi	profiles_profile_id_integrations_integration_messages_files_post	POST /profiles/{profileId}/integrations/{integration}/messages/files	Upload file
IntegrationsApi	profiles_profile_id_integrations_integration_webhooks_check_post	POST /profiles/{profileId}/integrations/{integration}/webhooks/check	Check webhook endpoint
IntegrationsApi	profiles_profile_id_integrations_integration_webhooks_dlq_get	GET /profiles/{profileId}/integrations/{integration}/webhooks/dlq	List webhook DLQ
IntegrationsApi	profiles_profile_id_integrations_integration_webhooks_dlq_redrive_post	POST /profiles/{profileId}/integrations/{integration}/webhooks/dlq/redrive	Redrive webhook DLQ
IntegrationsApi	profiles_profile_id_integrations_integration_webhooks_get	GET /profiles/{profileId}/integrations/{integration}/webhooks	List webhooks
IntegrationsApi	profiles_profile_id_integrations_integration_webhooks_id_delete	DELETE /profiles/{profileId}/integrations/{integration}/webhooks/{id}	Delete webhook
IntegrationsApi	profiles_profile_id_integrations_integration_webhooks_id_get	GET /profiles/{profileId}/integrations/{integration}/webhooks/{id}	Get webhook
IntegrationsApi	profiles_profile_id_integrations_integration_webhooks_id_patch	PATCH /profiles/{profileId}/integrations/{integration}/webhooks/{id}	Update webhook
IntegrationsApi	profiles_profile_id_integrations_integration_webhooks_id_test_post	POST /profiles/{profileId}/integrations/{integration}/webhooks/{id}/test	Test webhook
IntegrationsApi	profiles_profile_id_integrations_integration_webhooks_post	POST /profiles/{profileId}/integrations/{integration}/webhooks	Create webhook
IntegrationsApi	put_profiles_profile_id_integrations_integration_session	PUT /profiles/{profileId}/integrations/{integration}/session	Set integration session
IntegrationsApi	put_profiles_profile_id_integrations_integration_token	PUT /profiles/{profileId}/integrations/{integration}/token	Set bot token
MaxApi	delete_profiles_profile_id_integrations_integration_folders_folder_id	DELETE /profiles/{profileId}/integrations/{integration}/folders/{folderId}	Delete MAX folder
MaxApi	delete_profiles_profile_id_integrations_integration_messages_reactions	DELETE /profiles/{profileId}/integrations/{integration}/messages/reactions	Remove reaction
MaxApi	get_profiles_profile_id_integrations_integration_contacts	GET /profiles/{profileId}/integrations/{integration}/contacts	List contacts
MaxApi	get_profiles_profile_id_integrations_integration_contacts_blocked	GET /profiles/{profileId}/integrations/{integration}/contacts/blocked	List blocked contacts
MaxApi	get_profiles_profile_id_integrations_integration_devices	GET /profiles/{profileId}/integrations/{integration}/devices	List active MAX devices
MaxApi	get_profiles_profile_id_integrations_integration_folders	GET /profiles/{profileId}/integrations/{integration}/folders	List MAX folders
MaxApi	get_profiles_profile_id_integrations_integration_sessions	GET /profiles/{profileId}/integrations/{integration}/sessions	List active MAX sessions/devices
MaxApi	get_profiles_profile_id_integrations_integration_settings	GET /profiles/{profileId}/integrations/{integration}/settings	Get settings
MaxApi	get_profiles_profile_id_integrations_integration_settings_user	GET /profiles/{profileId}/integrations/{integration}/settings/user	Get MAX account settings
MaxApi	patch_profiles_profile_id_integrations_integration_account_profile	PATCH /profiles/{profileId}/integrations/{integration}/account/profile	Update MAX profile name/description
MaxApi	patch_profiles_profile_id_integrations_integration_settings	PATCH /profiles/{profileId}/integrations/{integration}/settings	Update settings
MaxApi	patch_profiles_profile_id_integrations_integration_settings_user	PATCH /profiles/{profileId}/integrations/{integration}/settings/user	Update MAX account settings
MaxApi	post_profiles_profile_id_integrations_integration_auth_sms_poll	POST /profiles/{profileId}/integrations/{integration}/auth/sms/poll	Poll authorization
MaxApi	post_profiles_profile_id_integrations_integration_auth_sms_start	POST /profiles/{profileId}/integrations/{integration}/auth/sms/start	Start SMS authorization
MaxApi	post_profiles_profile_id_integrations_integration_auth_sms_verify	POST /profiles/{profileId}/integrations/{integration}/auth/sms/verify	Send authorization code
MaxApi	post_profiles_profile_id_integrations_integration_chats_by_ids	POST /profiles/{profileId}/integrations/{integration}/chats/by-ids	Get chats by IDs
MaxApi	post_profiles_profile_id_integrations_integration_chats_subscription	POST /profiles/{profileId}/integrations/{integration}/chats/subscription	Subscribe/unsubscribe chat updates
MaxApi	post_profiles_profile_id_integrations_integration_contacts_by_ids	POST /profiles/{profileId}/integrations/{integration}/contacts/by-ids	Get contacts by IDs
MaxApi	post_profiles_profile_id_integrations_integration_contacts_last_online	POST /profiles/{profileId}/integrations/{integration}/contacts/last-online	Get contacts last online by IDs
MaxApi	post_profiles_profile_id_integrations_integration_contacts_search	POST /profiles/{profileId}/integrations/{integration}/contacts/search	Search contact by phone
MaxApi	post_profiles_profile_id_integrations_integration_folders	POST /profiles/{profileId}/integrations/{integration}/folders	Create MAX folder
MaxApi	post_profiles_profile_id_integrations_integration_messages_reactions	POST /profiles/{profileId}/integrations/{integration}/messages/reactions	Send reaction
MaxApi	post_profiles_profile_id_integrations_integration_messages_read	POST /profiles/{profileId}/integrations/{integration}/messages/read	Mark chat read
MaxApi	post_profiles_profile_id_integrations_integration_messages_typing	POST /profiles/{profileId}/integrations/{integration}/messages/typing	Send typing status
MaxApi	post_profiles_profile_id_integrations_integration_messages_unread	POST /profiles/{profileId}/integrations/{integration}/messages/unread	Mark chat as unread
MaxApi	post_profiles_profile_id_integrations_integration_reboot	POST /profiles/{profileId}/integrations/{integration}/reboot	Reboot profile
MaxApi	post_profiles_profile_id_integrations_integration_videos_resolve	POST /profiles/{profileId}/integrations/{integration}/videos/resolve	Resolve video links by video ID
MaxApi	profiles_profile_id_integrations_integration_avatar_post	POST /profiles/{profileId}/integrations/{integration}/avatar	Set profile picture
MaxApi	put_profiles_profile_id_integrations_integration_folders_order	PUT /profiles/{profileId}/integrations/{integration}/folders/order	Reorder MAX folders
MessagesApi	delete_profiles_profile_id_integrations_integration_messages_reactions	DELETE /profiles/{profileId}/integrations/{integration}/messages/reactions	Remove reaction
MessagesApi	post_profiles_profile_id_integrations_integration_messages	POST /profiles/{profileId}/integrations/{integration}/messages	Send message
MessagesApi	post_profiles_profile_id_integrations_integration_messages_delete	POST /profiles/{profileId}/integrations/{integration}/messages/delete	Delete message
MessagesApi	post_profiles_profile_id_integrations_integration_messages_edit	POST /profiles/{profileId}/integrations/{integration}/messages/edit	Edit message
MessagesApi	post_profiles_profile_id_integrations_integration_messages_forward	POST /profiles/{profileId}/integrations/{integration}/messages/forward	Forward message
MessagesApi	post_profiles_profile_id_integrations_integration_messages_history	POST /profiles/{profileId}/integrations/{integration}/messages/history	Get chat history
MessagesApi	post_profiles_profile_id_integrations_integration_messages_reactions	POST /profiles/{profileId}/integrations/{integration}/messages/reactions	Send reaction
MessagesApi	post_profiles_profile_id_integrations_integration_messages_read	POST /profiles/{profileId}/integrations/{integration}/messages/read	Mark chat read
MessagesApi	post_profiles_profile_id_integrations_integration_messages_reply	POST /profiles/{profileId}/integrations/{integration}/messages/reply	Reply message
MessagesApi	post_profiles_profile_id_integrations_integration_messages_typing	POST /profiles/{profileId}/integrations/{integration}/messages/typing	Send typing status
MessagesApi	post_profiles_profile_id_integrations_integration_messages_unread	POST /profiles/{profileId}/integrations/{integration}/messages/unread	Mark chat as unread
MessagesApi	post_profiles_profile_id_integrations_integration_videos_resolve	POST /profiles/{profileId}/integrations/{integration}/videos/resolve	Resolve video links by video ID
MessagesApi	profiles_profile_id_integrations_integration_messages_files_post	POST /profiles/{profileId}/integrations/{integration}/messages/files	Upload file
ModulesApi	get_account_modules	GET /account/modules	List account modules
ModulesApi	get_account_modules_usage	GET /account/modules/usage	Get account module usage
ModulesApi	put_account_modules_module_code	PUT /account/modules/{moduleCode}	Update account module
NotificationsApi	get_notifications	GET /notifications	List notifications
NotificationsApi	get_notifications_unread	GET /notifications/unread	Get unread count
NotificationsApi	post_notifications_mark_all	POST /notifications/mark-all	Mark all as read
NotificationsApi	post_notifications_mark_read	POST /notifications/mark-read	Mark as read
ProfilesApi	delete_profiles_profile_id	DELETE /profiles/{profileId}	Delete profile
ProfilesApi	get_profiles	GET /profiles	List profiles
ProfilesApi	get_profiles_profile_id	GET /profiles/{profileId}	Get profile
ProfilesApi	get_profiles_profile_id_actions	GET /profiles/{profileId}/actions	Get profile actions
ProfilesApi	get_profiles_profile_id_integrations_integration_contacts	GET /profiles/{profileId}/integrations/{integration}/contacts	List contacts
ProfilesApi	get_profiles_profile_id_integrations_integration_contacts_blocked	GET /profiles/{profileId}/integrations/{integration}/contacts/blocked	List blocked contacts
ProfilesApi	get_profiles_profile_id_integrations_integration_overview	GET /profiles/{profileId}/integrations/{integration}/overview	Get profile overview
ProfilesApi	get_profiles_profile_id_integrations_integration_status	GET /profiles/{profileId}/integrations/{integration}/status	Get profile status
ProfilesApi	patch_profiles_profile_id	PATCH /profiles/{profileId}	Update profile
ProfilesApi	patch_profiles_profile_id_integrations_integration_account_profile	PATCH /profiles/{profileId}/integrations/{integration}/account/profile	Update MAX profile name/description
ProfilesApi	post_profiles	POST /profiles	Create profile
ProfilesApi	post_profiles_profile_id_integrations_integration_contacts_by_ids	POST /profiles/{profileId}/integrations/{integration}/contacts/by-ids	Get contacts by IDs
ProfilesApi	post_profiles_profile_id_integrations_integration_contacts_last_online	POST /profiles/{profileId}/integrations/{integration}/contacts/last-online	Get contacts last online by IDs
ProfilesApi	post_profiles_profile_id_integrations_integration_contacts_search	POST /profiles/{profileId}/integrations/{integration}/contacts/search	Search contact by phone
ProfilesApi	post_profiles_profile_id_integrations_integration_reboot	POST /profiles/{profileId}/integrations/{integration}/reboot	Reboot profile
ProfilesApi	post_profiles_profile_id_renew	POST /profiles/{profileId}/renew	Renew profile
ProfilesApi	profiles_profile_id_integrations_integration_avatar_post	POST /profiles/{profileId}/integrations/{integration}/avatar	Set profile picture
ProfilesApi	put_profiles_profile_id_auto_renew	PUT /profiles/{profileId}/auto-renew	Update auto-renew
ScenariosApi	users_me_scenarios_get	GET /users/me/scenarios	List account scenarios
ScenariosApi	users_me_scenarios_id_delete	DELETE /users/me/scenarios/{id}	Delete account scenario
ScenariosApi	users_me_scenarios_put	PUT /users/me/scenarios	Upsert account scenario
SessionsApi	delete_profiles_profile_id_integrations_integration_session	DELETE /profiles/{profileId}/integrations/{integration}/session	Clear integration session
SessionsApi	delete_users_me_sessions_session_id	DELETE /users/me/sessions/{sessionId}	Revoke session
SessionsApi	get_profiles_profile_id_integrations_integration_devices	GET /profiles/{profileId}/integrations/{integration}/devices	List active MAX devices
SessionsApi	get_profiles_profile_id_integrations_integration_session	GET /profiles/{profileId}/integrations/{integration}/session	Get integration session
SessionsApi	get_profiles_profile_id_integrations_integration_session_chats	GET /profiles/{profileId}/integrations/{integration}/session/chats	Get integration chats
SessionsApi	get_profiles_profile_id_integrations_integration_sessions	GET /profiles/{profileId}/integrations/{integration}/sessions	List active MAX sessions/devices
SessionsApi	get_users_me_sessions	GET /users/me/sessions	List user sessions
SessionsApi	post_profiles_profile_id_integrations_integration_session_events	POST /profiles/{profileId}/integrations/{integration}/session/events	Get integration events
SessionsApi	post_profiles_profile_id_integrations_integration_session_start	POST /profiles/{profileId}/integrations/{integration}/session/start	Start integration session
SessionsApi	post_profiles_profile_id_integrations_integration_session_stop	POST /profiles/{profileId}/integrations/{integration}/session/stop	Stop integration session
SessionsApi	post_profiles_profile_id_integrations_integration_sync	POST /profiles/{profileId}/integrations/{integration}/sync	Sync integration profile
SessionsApi	post_users_me_sessions_revoke_all	POST /users/me/sessions/revoke-all	Revoke all sessions
SessionsApi	post_users_me_sessions_revoke_others	POST /users/me/sessions/revoke-others	Revoke other sessions
SessionsApi	put_profiles_profile_id_integrations_integration_session	PUT /profiles/{profileId}/integrations/{integration}/session	Set integration session
SettingsApi	get_profiles_profile_id_integrations_integration_settings	GET /profiles/{profileId}/integrations/{integration}/settings	Get settings
SettingsApi	get_profiles_profile_id_integrations_integration_settings_user	GET /profiles/{profileId}/integrations/{integration}/settings/user	Get MAX account settings
SettingsApi	patch_profiles_profile_id_integrations_integration_settings	PATCH /profiles/{profileId}/integrations/{integration}/settings	Update settings
SettingsApi	patch_profiles_profile_id_integrations_integration_settings_user	PATCH /profiles/{profileId}/integrations/{integration}/settings/user	Update MAX account settings
SystemApi	docs_get	GET /docs	API reference
SystemApi	get_status	GET /status	Service status
TokensApi	delete_users_me_api_tokens_id	DELETE /users/me/api-tokens/{id}	Revoke API token
TokensApi	get_users_me_api_scopes	GET /users/me/api-scopes	List available API scopes
TokensApi	get_users_me_api_tokens	GET /users/me/api-tokens	List API tokens
TokensApi	post_users_me_api_tokens	POST /users/me/api-tokens	Create API token
TokensApi	post_users_me_api_tokens_id_rotate	POST /users/me/api-tokens/{id}/rotate	Rotate API token
UsersApi	get_users_me	GET /users/me	Get current user
UsersApi	get_users_me_dashboard_summary	GET /users/me/dashboard-summary	Get dashboard summary
UsersApi	get_users_me_inbox_conversations	GET /users/me/inbox/conversations	List omnichannel inbox conversations
UsersApi	get_users_me_inbox_messages	GET /users/me/inbox/messages	List omnichannel inbox messages
UsersApi	post_users_me_inbox_conversations_action	POST /users/me/inbox/conversations/action	Toggle omnichannel conversation action
UsersApi	post_users_me_inbox_conversations_avatar	POST /users/me/inbox/conversations/avatar	Set omnichannel conversation avatar
UsersApi	post_users_me_inbox_conversations_title	POST /users/me/inbox/conversations/title	Set omnichannel conversation title
UsersApi	post_users_me_inbox_read	POST /users/me/inbox/read	Mark omnichannel conversation as read
UsersApi	post_users_me_inbox_send	POST /users/me/inbox/send	Send omnichannel inbox message
UsersApi	post_users_me_password	POST /users/me/password	Change current user password
UsersApi	users_me_scenarios_get	GET /users/me/scenarios	List account scenarios
UsersApi	users_me_scenarios_id_delete	DELETE /users/me/scenarios/{id}	Delete account scenario
UsersApi	users_me_scenarios_put	PUT /users/me/scenarios	Upsert account scenario
VkApi	profiles_profile_id_integrations_integration_oauth_callback_get	GET /profiles/{profileId}/integrations/{integration}/oauth/callback	VK OAuth callback
WebhooksApi	profiles_profile_id_integrations_integration_webhooks_check_post	POST /profiles/{profileId}/integrations/{integration}/webhooks/check	Check webhook endpoint
WebhooksApi	profiles_profile_id_integrations_integration_webhooks_dlq_get	GET /profiles/{profileId}/integrations/{integration}/webhooks/dlq	List webhook DLQ
WebhooksApi	profiles_profile_id_integrations_integration_webhooks_dlq_redrive_post	POST /profiles/{profileId}/integrations/{integration}/webhooks/dlq/redrive	Redrive webhook DLQ
WebhooksApi	profiles_profile_id_integrations_integration_webhooks_get	GET /profiles/{profileId}/integrations/{integration}/webhooks	List webhooks
WebhooksApi	profiles_profile_id_integrations_integration_webhooks_id_delete	DELETE /profiles/{profileId}/integrations/{integration}/webhooks/{id}	Delete webhook
WebhooksApi	profiles_profile_id_integrations_integration_webhooks_id_get	GET /profiles/{profileId}/integrations/{integration}/webhooks/{id}	Get webhook
WebhooksApi	profiles_profile_id_integrations_integration_webhooks_id_patch	PATCH /profiles/{profileId}/integrations/{integration}/webhooks/{id}	Update webhook
WebhooksApi	profiles_profile_id_integrations_integration_webhooks_id_test_post	POST /profiles/{profileId}/integrations/{integration}/webhooks/{id}/test	Test webhook
WebhooksApi	profiles_profile_id_integrations_integration_webhooks_post	POST /profiles/{profileId}/integrations/{integration}/webhooks	Create webhook

Documentation For Models

• AccountModuleItem
• AccountModuleUsageItem
• AccountModulesListResponseBody
• AccountModulesUsageResponseBody
• AccountSettings
• ApiScopeInfo
• ApiScopesListResponseBody
• ApiTokenItem
• ApiTokensListResponseBody
• AuthTokenInputBody
• AuthTokenOutputBody
• AuthorizationResultData
• BackupPayload
• BackupProfile
• BackupProfileAuth
• BackupUser
• BackupWebhook
• BotTokenInputBody
• BotTokenResponseBody
• BotTokenSetResponseBody
• ChangePasswordInputBody
• ChangePasswordResponseBody
• ChatHistoryInputBody
• ContactsListHumaBody
• ConversationActionInputBody
• ConversationActionResponseBody
• ConversationAvatarInputBody
• ConversationAvatarMeta
• ConversationAvatarResponseBody
• ConversationMeta
• CreateApiTokenInputBody
• CreateProfileInputBody
• CreateUserInputBody
• CreateUserResponseBody
• DashboardKPI
• DashboardMessagePoint
• DashboardMessages30d
• DashboardSetup
• DeleteMessageBody
• DeleteMessageInputBody
• EditMessageInputBody
• EmailVerifyConfirmInputBody
• EmailVerifyConfirmResponseBody
• EmailVerifyRequestInputBody
• EmailVerifyRequestResponseBody
• ErrorDetail
• ErrorModel
• ForwardMessageInputBody
• InboxConversationItem
• InboxConversationsListResponseBody
• InboxMessageItem
• InboxMessagesListResponseBody
• InboxReadInputBody
• InboxReadResponseBody
• LogoutBody
• MarkReadInputBody
• MaxBlockedContactsResponseBody
• MaxChatSubscriptionInputBody
• MaxChatSubscriptionResponseBody
• MaxChatsByIDsInputBody
• MaxChatsByIDsResponseBody
• MaxContact
• MaxContactName
• MaxContactsByIDsInputBody
• MaxContactsByIDsResponseBody
• MaxContactsLastOnlineInputBody
• MaxContactsLastOnlineResponseBody
• MaxCreateFolderInputBody
• MaxFolder
• MaxFoldersResponseBody
• MaxProfile
• MaxReorderFoldersInputBody
• MaxSession
• MaxSessionsResponseBody
• MaxSetProfileInputBody
• MaxSetProfileResponseBody
• MaxSetUserSettingsInputBody
• MaxUserSettingsPatch
• MaxUserSettingsResponseBody
• MaxUserSettingsState
• MaxVideoResolveInputBody
• MaxVideoResolveResponseBody
• MaxWSCallInputBody
• MaxWSCallResponseBody
• MessageResponseBody
• NotificationItem
• NotificationsListResponseBody
• OAuthPendingCompleteEmailInputBody
• OAuthProviderInfo
• OAuthProvidersOutputBody
• OAuthResolveOutputBody
• OAuthStartOutputBody
• Password2FAInputBody
• PhoneAuthCodeInputBody
• PhoneAuthCodeResponseBody
• PhoneAuthPasswordInputBody
• PhoneAuthPasswordResponseBody
• PhoneAuthStartInputBody
• PhoneAuthStartResponseBody
• PollAuthorizationBody
• PollAuthorizationInputBody
• ProfileActionItem
• ProfileActionsListResponseBody
• ProfileRenewOutputBody
• ProfileResponse
• ProfilesListResponseBody
• QRStatusResponseBody
• ReactionRef
• ReactionStruct
• ReadChatBody
• ReadChatHumaInputBody
• RebootProfileBody
• RemoveReactionBody
• RemoveReactionHumaInputBody
• RestoreDataInputBody
• SearchContactInputBody
• SearchContactResponseBody
• SendAuthorizationCodeBody
• SendAuthorizationCodeInputBody
• SendMessageInputBody
• SendReactionBody
• SendReactionHumaInputBody
• SendReplyMessageInputBody
• SendTypingInputBody
• SendTypingResponseBody
• SessionActionInputBody
• SessionChatsResponseBody
• SessionClearResponseBody
• SessionDataInputBody
• SessionEventsResponseBody
• SessionGetResponseBody
• SessionItem
• SessionSetResponseBody
• SessionStartInputBody
• SessionStartResponseBody
• SessionStopResponseBody
• SessionsListResponseBody
• SetSettingsBody
• SetSettingsInputBody
• StartAuthorizationBody
• StartAuthorizationInputBody
• StateProfileBody
• StatusResponseBody
• SyncProfileInputBody
• SyncProfileResponseBody
• TelegramPhoneVerifyConfirmInputBody
• TelegramPhoneVerifyConfirmResponseBody
• TelegramPhoneVerifyStartInputBody
• TelegramPhoneVerifyStartResponseBody
• TopUpInputBody
• TopUpResponseBody
• TopUpStatusResponseBody
• TopUpStatusResponseItem
• TopUpsListResponseBody
• TransactionItem
• TransactionsListResponseBody
• UnreadCountResponseBody
• UpdateAccountModuleInputBody
• UpdateAccountModuleResponseBody
• UpdateProfileAutoRenewInputBody
• UpdateProfileInputBody
• UserDashboardSummaryResponseBody
• UserExistsResponseBody
• UserInboxAvailableProfile
• UserInboxConversationActionInputBody
• UserInboxConversationActionResponseBody
• UserInboxConversationAvatarInputBody
• UserInboxConversationAvatarResponseBody
• UserInboxConversationItem
• UserInboxConversationMeta
• UserInboxConversationTitleInputBody
• UserInboxConversationTitleResponseBody
• UserInboxConversationsListResponseBody
• UserInboxMessageItem
• UserInboxMessagesListResponseBody
• UserInboxReadInputBody
• UserInboxReadResponseBody
• UserInboxSendInputBody
• UserInboxSendResponseBody
• UserMeResponseBody

Documentation For Authorization

Authentication schemes defined for the API:

ApiKeyAuth

• Type: API key
• API key parameter name: X-Profile-Token
• Location: HTTP header

BearerAuth

• Type: Bearer authentication (JWT)

Author