public-api-server-connector

Mentortools public API service

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

• API version: 0.1.0
• Package version: 1.0.0+2350354943
• Generator version: 7.20.0
• Build package: org.openapitools.codegen.languages.PythonPydanticV1ClientCodegen

Requirements.

Python 3.7+

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 public_api_server_connector

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 public_api_server_connector

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import time
import public_api_server_connector
from public_api_server_connector.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 = public_api_server_connector.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 Bearer authorization: HTTPBearer
configuration = public_api_server_connector.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
async with public_api_server_connector.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = public_api_server_connector.ApiKeyAuthApi(api_client)
    course_create = public_api_server_connector.CourseCreate() # CourseCreate | 

    try:
        # Add Course
        api_response = await api_instance.api_key_auth_add_course(course_create)
        print("The response of ApiKeyAuthApi->api_key_auth_add_course:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ApiKeyAuthApi->api_key_auth_add_course: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost

Documentation For Models

• Address
• ApiKeyCreate
• ApiKeyCreateResponse
• ApiKeyGet
• ApiKeyPatch
• ApiKeyUpdate
• ApiLogGet
• AttachedFile
• AttachedFileCreate
• AttachedFileCreateOrUpdate
• AttachedFilePatch
• AttachedFilesInner
• ButtonPosition
• ButtonSize
• ButtonTarget
• Category
• CategoryMethodOptions
• CategoryPermissions
• Content
• ContentBlock
• ContentBlockCreate
• ContentBlockPatch
• ContentBlockTypeStrEnum
• ContentBlockUpdate
• ContentBlocksInner
• ContentBlocksInner1
• Course
• CourseAccessTypeStrEnum
• CourseContentBlock
• CourseCreate
• CourseModule
• CourseModuleCreate
• CourseModulePatch
• CourseModuleSimple
• CourseModuleUpdate
• CourseModuleViewTypeStrEnum
• CoursePatch
• CoursePaymentTypeStrEnum
• CourseSimple
• CourseSubmodule
• CourseSubmoduleCreate
• CourseSubmodulePatch
• CourseSubmoduleUpdate
• CourseUpdate
• File
• FileUpdate
• FileUploadResult
• Folder
• FolderCreate
• FolderUpdate
• HTTPValidationError
• HttpMethod
• IpnOrderPayment
• IpnOrderPaymentResponse
• IpnTransaction
• LessonTypeStrEnum
• LocationInner
• MarketplaceBuyer
• ModuleLesson
• ModuleLessonCreate
• ModuleLessonPatch
• ModuleLessonPatchAttachedFiles
• ModuleLessonPatchContent
• ModuleLessonSimple
• ModuleLessonUpdate
• PortalInfo
• PortalMemberBase
• ResponseWrapper
• ResponseWrapperApiKeyCreateResponse
• ResponseWrapperApiKeyGet
• ResponseWrapperApiLogGet
• ResponseWrapperBool
• ResponseWrapperCourse
• ResponseWrapperCourseModule
• ResponseWrapperCourseModuleSimple
• ResponseWrapperCourseSimple
• ResponseWrapperCourseSubmodule
• ResponseWrapperFile
• ResponseWrapperFileUploadResult
• ResponseWrapperFolder
• ResponseWrapperInt
• ResponseWrapperIpnOrderPaymentResponse
• ResponseWrapperListApiKeyGet
• ResponseWrapperListApiLogGet
• ResponseWrapperListCategory
• ResponseWrapperListContentBlock
• ResponseWrapperListCourseModuleSimple
• ResponseWrapperListCourseSimple
• ResponseWrapperListCourseSubmodule
• ResponseWrapperListFile
• ResponseWrapperListFolder
• ResponseWrapperListModuleLessonSimple
• ResponseWrapperListStr
• ResponseWrapperModuleLesson
• ResponseWrapperModuleLessonSimple
• ResponseWrapperTokenInfo
• Result
• TokenInfo
• ValidationError

Documentation For Authorization

Authentication schemes defined for the API:

HTTPBearer

• Type: Bearer authentication

Author