chat-server-connector-v2

Mentortools service for chatting

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

• API version: 0.1.0
• Package version: 1.7.7+68751
• 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:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import chat_server_connector_v2

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import chat_server_connector_v2

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import chat_server_connector_v2
from chat_server_connector_v2.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = chat_server_connector_v2.Configuration(
    host = "http://localhost"
)

# 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: APIKeyHeader
configuration.api_key['APIKeyHeader'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['APIKeyHeader'] = 'Bearer'


# Enter a context with an instance of the API client
async with chat_server_connector_v2.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = chat_server_connector_v2.AdminApi(api_client)
    portal_member_id = 56 # int | 

    try:
        # Delete Portal Member Chats
        api_response = await api_instance.chat_api_delete_portal_member_chats(portal_member_id)
        print("The response of AdminApi->chat_api_delete_portal_member_chats:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AdminApi->chat_api_delete_portal_member_chats: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost

Documentation For Models

• AiAssistantGet
• AiAssistantGoalGet
• AiAssistantLexiconItem
• AiUsageLogRead
• AssistantFunction
• AssistantType
• AssistantUsageType
• ChatGetWithMembers
• ChatGetWithMembersAndMessages
• ChatGetWithMembersAndMessagesWithMetadata
• ChatListGet
• ChatListGetV2
• ChatMemberCreateOrUpdate
• ChatMemberGet
• ChatMemberRole
• ChatMemberRoleAdd
• ChatMembership
• ChatMessage
• ChatMessageAttachmentCreate
• ChatMessageAttachmentRead
• ChatMessageAttachmentReadWithMetadata
• ChatMessageAttachmentType
• ChatMessageCreate
• ChatMessageInsert
• ChatMessageReactionCreate
• ChatMessageReactionRead
• ChatMessageRead
• ChatMessageReadSimple
• ChatMessageReadWithMetadata
• ChatMessageReplyToRead
• ChatMessageType
• ChatNew
• ChatPatch
• ChatPollCreate
• ChatPollOptionCreate
• ChatPollOptionRead
• ChatPollRead
• ChatPollVoteCreate
• ChatSessionGet
• ChatSessionGetWithChatData
• ChatSessionType
• ChatSettingsCreateOrUpdate
• ChatSettingsGet
• ChatType
• ChatUpdate
• ChatUserSettingsGet
• ChatUserSettingsUpdate
• CollectionState
• CollectionStatus
• ConsumedUnits
• Contact
• ContactAddress
• ConversationStyle
• CourseModulePublic
• CoursePaymentTypeStrEnum
• CoursePublic
• CreditEventType
• Entity
• ExternalSystemMessage
• ExternalSystemType
• ExternalSystemUserGet
• ExternalSystemUserUpdate
• FeedbackCreate
• FeedbackRead
• FeedbackType
• FeedbackWithSessionRead
• GoalEngagementPresetGet
• GoalInteractionsSummary
• HTTPValidationError
• KnowledgebaseState
• LocationInner
• ModuleLessonPublic
• MtBreakdown
• Operation
• ReactionEmoji
• ResponseWrapper
• ResponseWrapperBool
• ResponseWrapperChatGetWithMembersAndMessages
• ResponseWrapperChatGetWithMembersAndMessagesWithMetadata
• ResponseWrapperChatMessageReadSimple
• ResponseWrapperChatMessageReadWithMetadata
• ResponseWrapperChatPollRead
• ResponseWrapperChatSessionGet
• ResponseWrapperChatSessionGetWithChatData
• ResponseWrapperChatSettingsGet
• ResponseWrapperChatUserSettingsGet
• ResponseWrapperContact
• ResponseWrapperExternalSystemUserGet
• ResponseWrapperInt
• ResponseWrapperListChatListGet
• ResponseWrapperListChatListGetV2
• ResponseWrapperListChatMemberGet
• ResponseWrapperListChatMessageReadWithMetadata
• ResponseWrapperListChatSessionGetWithChatData
• ResponseWrapperListContact
• ResponseWrapperListFeedbackWithSessionRead
• ResponseWrapperListScheduledMessageGet
• ResponseWrapperListSearchSourceEvent
• ResponseWrapperSearchAccessResult
• ResponseWrapperSearchSourceEvent
• ResponseWrapperUnreadCount
• Result
• RoleEnum
• SchedulableMessageType
• ScheduleKind
• ScheduledMessageCreate
• ScheduledMessageGet
• ScheduledMessagePatch
• ScheduledMessageStatus
• ScheduledMessageStatusUpdate
• SearchAccessRequest
• SearchAccessResult
• SearchBreadcrumb
• SearchEntityType
• SearchProjectionGetRequest
• SearchProjectionListRequest
• SearchSourceEvent
• SearchSourceOperation
• SearchSourcePayload
• SearchTeamMemberAccess
• UnreadCount
• UsageDataFromFront
• UsageDataFromFrontV2
• UsageDataV2
• User
• ValidationError
• WSEvent

Documentation For Authorization

Authentication schemes defined for the API:

HTTPBearer

• Type: Bearer authentication

APIKeyHeader

• Type: API key
• API key parameter name: server_name
• Location: HTTP header

Author