Fastify Template API

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for william_keplar from gravatar.com william_keplar

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: LicenseRef-Proprietary
  • Author: OpenAPI Generator community
  • Tags OpenAPI , OpenAPI-Generator , Fastify Template API
  • Requires: Python >=3.9
Report project as malware

Project description

keplar_api

API documentation using Swagger

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

  • API version: 1.0.0
  • Package version: 0.0.567804984
  • Generator version: 7.16.0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.9+

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 keplar_api

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 keplar_api

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import keplar_api
from keplar_api.rest import ApiException
from pprint import pprint

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

# 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 = keplar_api.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
async with keplar_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = keplar_api.DefaultApi(api_client)
    user_id = 'user_id_example' # str | 
    add_user_to_workspace_request = keplar_api.AddUserToWorkspaceRequest() # AddUserToWorkspaceRequest | 

    try:
        # Add user to a workspace
        api_response = await api_instance.add_user_to_workspace(user_id, add_user_to_workspace_request)
        print("The response of DefaultApi->add_user_to_workspace:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling DefaultApi->add_user_to_workspace: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost:3000

Class Method HTTP request Description
DefaultApi add_user_to_workspace POST /api/admin/users/{userId}/workspaces Add user to a workspace
DefaultApi add_workspace_member POST /api/admin/workspaces/{workspaceId}/members Add workspace member
DefaultApi analyze_notebook POST /api/notebooks/{notebookId}/analyze Trigger analysis/report generation for a notebook
DefaultApi api_auth_google_get GET /api/auth/google
DefaultApi api_auth_google_redirect_get GET /api/auth/google/redirect
DefaultApi api_call_messages_search_post POST /api/callMessages/search Search conversation messages
DefaultApi api_calls_call_id_get GET /api/calls/{callId} Get call
DefaultApi api_calls_call_id_messages_index_get GET /api/calls/{callId}/messages/{index} Get conversation message
DefaultApi api_copilotkit_post POST /api/copilotkit
DefaultApi api_demos_create_demo_invite_post POST /api/demos/createDemoInvite Create demo invite
DefaultApi api_files_file_id_delete DELETE /api/files/{fileId} Delete a file
DefaultApi api_files_file_id_get GET /api/files/{fileId} Get file metadata
DefaultApi api_files_file_id_signed_url_post POST /api/files/{fileId}/signed-url Get a signed URL for file access
DefaultApi api_files_post POST /api/files/ Upload a file
DefaultApi api_invite_code_code_participant_code_participant_code_join_get GET /api/inviteCode/{code}/participantCode/{participantCode}/join
DefaultApi api_invite_code_code_start_get GET /api/inviteCode/{code}/start
DefaultApi api_invites_id_get GET /api/invites/{id} Get invite
DefaultApi api_invites_id_participant_invites_get GET /api/invites/{id}/participantInvites Get participant invites
DefaultApi api_invites_id_participant_invites_participant_id_get GET /api/invites/{id}/participantInvites/{participantId} Get participant invite
DefaultApi api_invites_id_participant_invites_participant_id_put PUT /api/invites/{id}/participantInvites/{participantId} Update participant invite
DefaultApi api_invites_id_participant_invites_post POST /api/invites/{id}/participantInvites Create participant invite
DefaultApi api_invites_id_participants_participant_id_call_metadata_get GET /api/invites/{id}/participants/{participantId}/callMetadata Get call metadata by invite ID and participant ID
DefaultApi api_invites_id_put PUT /api/invites/{id}/ Update invite
DefaultApi api_invites_id_response_attribute_stats_get GET /api/invites/{id}/responseAttributeStats Get invite response attribute stats
DefaultApi api_invites_id_responses_get GET /api/invites/{id}/responses Get invite responses
DefaultApi api_invites_id_responses_post POST /api/invites/{id}/responses Create invite response
DefaultApi api_invites_id_responses_response_id_call_metadata_get GET /api/invites/{id}/responses/{responseId}/callMetadata Get call metadata by invite ID and response ID
DefaultApi api_invites_id_responses_response_id_get GET /api/invites/{id}/responses/{responseId} Get invite response
DefaultApi api_invites_id_responses_response_id_put PUT /api/invites/{id}/responses/{responseId} Update invite response
DefaultApi api_invites_post POST /api/invites/ Create invite
DefaultApi api_projects_draft_get GET /api/projects/draft Get draft project
DefaultApi api_projects_post POST /api/projects/ Create project
DefaultApi api_projects_project_id_analysis_post POST /api/projects/{projectId}/analysis Create project analysis
DefaultApi api_projects_project_id_delete_post POST /api/projects/{projectId}/delete Delete or archive project
DefaultApi api_projects_project_id_files_file_id_delete DELETE /api/projects/{projectId}/files/{fileId} Remove a file from a project
DefaultApi api_projects_project_id_files_file_id_put PUT /api/projects/{projectId}/files/{fileId} Update project file metadata
DefaultApi api_projects_project_id_files_get GET /api/projects/{projectId}/files Get files for a project
DefaultApi api_projects_project_id_files_post POST /api/projects/{projectId}/files Add an existing file to a project
DefaultApi api_projects_project_id_launch_post POST /api/projects/{projectId}/launch Launch project
DefaultApi api_projects_project_id_put PUT /api/projects/{projectId} Update project
DefaultApi api_projects_project_id_search_transcripts_post POST /api/projects/{projectId}/searchTranscripts Search project transcripts
DefaultApi api_threads_get GET /api/threads/ Get threads
DefaultApi api_threads_thread_id_files_get GET /api/threads/{threadId}/files Get thread files
DefaultApi api_threads_thread_id_post POST /api/threads/{threadId} Upsert thread
DefaultApi api_threads_thread_id_project_brief_document_versions_get GET /api/threads/{threadId}/project-brief-document-versions Get project brief document versions from thread state history
DefaultApi api_threads_thread_id_project_brief_document_versions_post POST /api/threads/{threadId}/project-brief-document-versions Create project brief document version from thread state
DefaultApi api_threads_thread_id_project_brief_document_versions_version_put PUT /api/threads/{threadId}/project-brief-document-versions/{version} Update a specific project brief document version
DefaultApi api_threads_thread_id_project_brief_versions_get GET /api/threads/{threadId}/project-brief-versions Get project brief versions from thread state history
DefaultApi api_threads_thread_id_project_brief_versions_post POST /api/threads/{threadId}/project-brief-versions Create project draft versions from thread state history
DefaultApi api_users_id_get GET /api/users/{id} Get user and config data
DefaultApi api_vapi_webhook_post POST /api/vapi/webhook
DefaultApi create_artifact POST /api/projects/{projectId}/artifacts Create artifact
DefaultApi create_code_invite_response POST /api/inviteCode/{code}/responses Create invite response for invite code
DefaultApi create_code_invite_response_from_existing POST /api/inviteCode/{code}/responses/{responseId}/createNewResponse Create invite response from existing response
DefaultApi create_dummy_user POST /api/admin/users/dummy Create a dummy user for sales demos
DefaultApi create_email_share POST /api/sharing/share-entities/{shareEntityId}/emails Add email access to a share
DefaultApi create_notebook POST /api/notebooks/ Create a new notebook
DefaultApi create_notebook_artifact POST /api/notebooks/{notebookId}/artifacts Create an empty artifact for a notebook
DefaultApi create_org POST /api/admin/orgs Create a new organization
DefaultApi create_project_preview_invite POST /api/projects/{projectId}/previewInvite Create a preview invite for this project based on audienceSettings
DefaultApi create_project_share POST /api/sharing/projects/{projectId} Create a share link for a project
DefaultApi create_test_participant_code_invite POST /api/inviteCode/{code}/participantCode/{participantCode}/test Create test invite for participant
DefaultApi create_transcript_insight_for_code_invite_response POST /api/inviteCode/{code}/responses/{responseId}/transcriptInsight Create transcript insight for invite response
DefaultApi create_workspace POST /api/admin/workspaces Create workspace
DefaultApi delete_artifact DELETE /api/projects/{projectId}/artifacts/{artifactId} Delete artifact
DefaultApi delete_email_share DELETE /api/sharing/share-entities/{shareEntityId}/emails/{email} Remove email access from a share
DefaultApi delete_notebook DELETE /api/notebooks/{notebookId} Delete a notebook
DefaultApi delete_notebook_artifact_version_group DELETE /api/notebooks/{notebookId}/artifacts/{versionGroupId} Delete all artifacts in a version group
DefaultApi delete_project_search_index DELETE /api/projects/{projectId}/searchIndex Delete project search index from Qdrant
DefaultApi delete_share_entity DELETE /api/sharing/share-entities/{shareEntityId} Delete a share entity
DefaultApi download_invite_responses GET /api/invites/{id}/responses/download Download invite responses as CSV
DefaultApi download_share_invite_responses GET /api/share/{shareToken}/invites/{inviteId}/responses/download Download invite responses as CSV
DefaultApi generate_presentation_artifact POST /api/projects/{projectId}/artifacts/{artifactId}/generate Generate presentation via Gamma API for a presentation artifact
DefaultApi get_artifact GET /api/artifacts/{artifactId} Get artifact by ID
DefaultApi get_artifact_version_groups GET /api/projects/{projectId}/artifacts Get project artifact version groups
DefaultApi get_call_metadata_for_code_invite_response GET /api/inviteCode/{code}/responses/{responseId}/callMetadata Get call metadata for invite response
DefaultApi get_code_invite GET /api/inviteCode/{code}/ Get invite by code
DefaultApi get_code_invite_participant_remaining_responses GET /api/inviteCode/{code}/remainingResponses Get remaining responses count for participant
DefaultApi get_code_invite_participant_response GET /api/inviteCode/{code}/participantResponse Get invite response for participant
DefaultApi get_code_invite_response GET /api/inviteCode/{code}/responses/{responseId} Get invite response
DefaultApi get_code_invite_response_redirect GET /api/inviteCode/{code}/responses/{responseId}/redirect Get redirect URL for invite response
DefaultApi get_code_participant_invite GET /api/inviteCode/{code}/participantCode/{participantCode} Get participant invite for invite code
DefaultApi get_notebook GET /api/notebooks/{notebookId} Get a notebook by ID
DefaultApi get_notebook_artifacts GET /api/notebooks/{notebookId}/artifacts Get all artifacts generated from a notebook
DefaultApi get_notebook_projects GET /api/notebooks/{notebookId}/projects Get all projects associated with a notebook
DefaultApi get_notebooks GET /api/notebooks/ Get all notebooks accessible to user
DefaultApi get_org GET /api/admin/orgs/{orgId} Get organization details
DefaultApi get_org_members GET /api/admin/orgs/{orgId}/members Get organization members
DefaultApi get_orgs GET /api/admin/orgs List organizations with stats
DefaultApi get_project GET /api/projects/{projectId} Get project
DefaultApi get_project_artifact GET /api/projects/{projectId}/artifacts/{artifactId} Get project artifact by ID
DefaultApi get_project_response_attribute_stats GET /api/projects/{projectId}/responseAttributeStats Get project response attribute stats
DefaultApi get_project_responses_metadata GET /api/projects/{projectId}/responsesMetadata Get project responses metadata
DefaultApi get_project_shares GET /api/projects/{projectId}/shares Get all shares for a project
DefaultApi get_projects GET /api/projects/ Get projects
DefaultApi get_share_entities GET /api/sharing/share-entities List all share entities created by the user
DefaultApi get_shared_artifact GET /api/share/{shareToken}/artifacts/{artifactId} Get shared artifact by ID
DefaultApi get_shared_artifact_version_groups GET /api/share/{shareToken}/artifacts Get shared project artifacts version groups
DefaultApi get_shared_call GET /api/share/{shareToken}/calls/{callId} Get shared call data with conversation messages
DefaultApi get_shared_call_metadata GET /api/share/{shareToken}/invites/{inviteId}/responses/{responseId}/callMetadata Get shared call metadata by invite ID and response ID
DefaultApi get_shared_invite_response GET /api/share/{shareToken}/invites/{inviteId}/responses/{responseId} Get a single response by ID for a shared invite
DefaultApi get_shared_invite_response_attribute_stats GET /api/share/{shareToken}/invites/{inviteId}/response-attribute-stats Get attribute stats for shared invite responses
DefaultApi get_shared_invite_responses GET /api/share/{shareToken}/invites/{inviteId}/responses Get responses for a shared invite
DefaultApi get_shared_project GET /api/share/{shareToken}/project Get shared project data
DefaultApi get_shared_project_response_attribute_stats GET /api/share/{shareToken}/project-response-attribute-stats Get shared project response attribute stats
DefaultApi get_shared_project_responses_metadata GET /api/share/{shareToken}/project-responses-metadata Get shared project responses metadata
DefaultApi get_user_workspaces GET /api/admin/users/{userId}/workspaces Get user workspaces and all available workspaces
DefaultApi get_workspace_members GET /api/admin/workspaces/{workspaceId}/members Get workspace members
DefaultApi get_workspaces GET /api/admin/workspaces Get all workspaces
DefaultApi impersonate_user POST /api/admin/impersonate Impersonate a user
DefaultApi index_project_transcripts POST /api/projects/{projectId}/indexTranscripts Index project transcripts into Qdrant for semantic search
DefaultApi invite_customers POST /api/admin/invite-customers Bulk invite customers - creates org/workspace if needed
DefaultApi invite_user POST /api/admin/users/{userId}/invite Send invite to transfer dummy user to customer
DefaultApi join_code_invite GET /api/inviteCode/{code}/join Join invite by code
DefaultApi join_participant_code_invite GET /api/inviteCode/{code}/participantCode/{participantCode}/start Join invite by code and participant code
DefaultApi login POST /api/auth/login Login with email and password
DefaultApi logout POST /api/auth/logout Logout user
DefaultApi remove_user_from_workspace DELETE /api/admin/users/{userId}/workspaces/{workspaceId} Remove user from a workspace
DefaultApi remove_workspace_member DELETE /api/admin/workspaces/{workspaceId}/members/{memberId} Remove workspace member
DefaultApi request_magic_link POST /api/auth/send-magic-link Request magic link for passwordless login
DefaultApi request_password_reset POST /api/auth/send-reset-password-email Request password reset email
DefaultApi request_share_access POST /api/share/{shareToken}/request-access Request access to a share by email
DefaultApi resend_verification POST /api/auth/send-verification-email Resend email verification
DefaultApi reset_password POST /api/auth/update-password Reset password with token
DefaultApi save_search POST /api/notebooks/{notebookId}/search/save Save search results as a new artifact
DefaultApi search_response_messages POST /api/projects/{projectId}/searchResponseMessages Search response messages by inviteResponseId and messageIndex
DefaultApi search_shared_response_messages POST /api/share/{shareToken}/search-response-messages Search shared response messages by responseId and messageIndex
DefaultApi search_users POST /api/admin/users/search Search users by email or name
DefaultApi send_user_password_reset POST /api/admin/users/{userId}/send-reset-password Send password reset email to user (admin-triggered)
DefaultApi signup POST /api/auth/signup Sign up with email and password
DefaultApi start_call_for_code_invite_response GET /api/inviteCode/{code}/responses/{responseId}/startCall Start call for invite response
DefaultApi start_phone_call_for_code_invite_response POST /api/inviteCode/{code}/responses/{responseId}/startPhoneCall Start phone call for invite response
DefaultApi update_artifact PUT /api/projects/{projectId}/artifacts/{artifactId} Update artifact
DefaultApi update_call_for_code_invite_response PUT /api/inviteCode/{code}/responses/{responseId}/updateCall Update call for invite response
DefaultApi update_code_invite_response PUT /api/inviteCode/{code}/responses/{responseId} Update invite response
DefaultApi update_notebook PUT /api/notebooks/{notebookId} Update a notebook
DefaultApi update_notebook_sources POST /api/notebooks/{notebookId}/sources Add or remove project sources from a notebook
DefaultApi update_org PUT /api/admin/orgs/{orgId} Update organization name
DefaultApi update_org2_fa PUT /api/admin/orgs/{orgId}/2fa Toggle 2FA for organization
DefaultApi update_org_default_workspace PUT /api/admin/orgs/{orgId}/default-workspace Set/update organization default workspace
DefaultApi update_search PATCH /api/notebooks/{notebookId}/search/{artifactId} Update existing search artifact
DefaultApi update_share_entity PUT /api/sharing/share-entities/{shareEntityId} Update a share entity
DefaultApi update_user_default_workspace PUT /api/admin/users/{userId}/default-workspace Update user default workspace (auto-adds user if not member)
DefaultApi update_workspace_member PUT /api/admin/workspaces/{workspaceId}/members/{memberId} Update workspace member
DefaultApi upload_call_video POST /api/inviteCode/{code}/responses/{responseId}/calls/{callId}/video Upload video recording for a call
DefaultApi verify_email POST /api/auth/verify-email Verify email address with token
DefaultApi verify_email_access_for_share POST /api/share/{shareToken}/verify Verify email access for a share
DefaultApi verify_magic_link POST /api/auth/verify-magic-link Verify magic link token

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

bearerAuth

  • Type: Bearer authentication (JWT)

Author

Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for william_keplar from gravatar.com william_keplar

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: LicenseRef-Proprietary
  • Author: OpenAPI Generator community
  • Tags OpenAPI , OpenAPI-Generator , Fastify Template API
  • Requires: Python >=3.9

Release history Release notifications | RSS feed

0.0.4228895289

0.0.4212229053

0.0.3941900158

0.0.3905150158

0.0.3810178086

0.0.3562341150

0.0.3429265936

0.0.3185517964

0.0.3128796574

0.0.2946617692

0.0.2546167781

0.0.2512307307

0.0.2449158425

0.0.2239787250

0.0.2176925439

0.0.2145060448

0.0.2027946309

0.0.1980830873

0.0.1408486190

0.0.1407799415

0.0.948089733

0.0.702985079

0.0.594580777

This version

0.0.567804984

0.0.524208904

0.0.417004582

0.0.404142931

0.0.248716488

0.0.158679332

0.0.87364633

0.0.69033999

0.0.59153558

0.0.7247643

0.0.39

0.0.38

0.0.37

0.0.36

0.0.35

0.0.33

0.0.32

0.0.31

0.0.30

0.0.29

0.0.28

0.0.27

0.0.26

0.0.25

0.0.24

0.0.23

0.0.22

0.0.21

0.0.20

0.0.19

0.0.18

0.0.17

0.0.16

0.0.15

0.0.14

0.0.13

0.0.6

0.0.5

0.0.3

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

keplar_api-0.0.567804984.tar.gz (1.0 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

keplar_api-0.0.567804984-py3-none-any.whl (560.3 kB view details)

Uploaded Python 3

File details

Details for the file keplar_api-0.0.567804984.tar.gz.

File metadata

  • Download URL: keplar_api-0.0.567804984.tar.gz
  • Upload date:
  • Size: 1.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for keplar_api-0.0.567804984.tar.gz
Algorithm Hash digest
SHA256 0ebccc67715b84f2fe809f546325c8a7e50508419e399c7e26eabb5bbcf69326
MD5 d5add3a19e381e53e94e6e5960eac5ed
BLAKE2b-256 2c3d168388b7e62dc9110bc3dfdf1168bcd9bdd4c65fefed91b85f34f3b8c29f

See more details on using hashes here.

File details

Details for the file keplar_api-0.0.567804984-py3-none-any.whl.

File metadata

File hashes

Hashes for keplar_api-0.0.567804984-py3-none-any.whl
Algorithm Hash digest
SHA256 4debb34dac1d4f319ba7ef36cf847430ff38d3577a26cae9e49627d9b16a9332
MD5 0daec0cbf98c5e6d6dd362420d78488a
BLAKE2b-256 f4d9087bd91b7fb1768c610314e51eef07d63394c24504e523ece7c9399a363b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page