mentortools/libs/: marketplace-server-connector-v2-1.0.0+2677876651 metadata and description

Simple index Newer version available

Mentortools Marketplace Server

author OpenAPI Generator community
author_email OpenAPI Generator Community <team@openapitools.org>
description_content_type text/markdown
keywords OpenAPI, OpenAPI-Generator, Mentortools Marketplace Server
project_urls
  • Repository, https://github.com/GIT_USER_ID/GIT_REPO_ID
requires_dist
  • python-dateutil>=2.8.2
  • aiohttp>=3.8.4
  • aiohttp-retry>=2.8.3
  • pydantic>=2.11
  • typing-extensions>=4.7.1
requires_python >=3.9
File Tox results History
marketplace_server_connector_v2-1.0.0+2677876651-py3-none-any.whl
Size
92 KB
Type
Python Wheel
Python
3
marketplace_server_connector_v2-1.0.0+2677876651.tar.gz
Size
46 KB
Type
Source

marketplace-server-connector-v2

Mentortools service for ingesting payment-provider webhooks into normalized order events

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

Requirements.

Python 3.10+

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 marketplace_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 marketplace_server_connector_v2

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import marketplace_server_connector_v2
from marketplace_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 = marketplace_server_connector_v2.Configuration(
    host = "http://localhost"
)



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

    try:
        # Health check
        api_response = await api_instance.health_health_get()
        print("The response of HealthApi->health_health_get:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling HealthApi->health_health_get: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description
HealthApi health_health_get GET /health Health check
ImportApi import_orders_v1_import_orders_post POST /v1/import/orders Import historical purchases as proper orders (batch)
IntegrationsApi create_v1_integrations_post POST /v1/integrations Connect a provider integration
IntegrationsApi delete_integration_v1_integrations_integration_id_delete DELETE /v1/integrations/{integration_id} Disconnect (delete) an integration
IntegrationsApi get_integration_v1_integrations_integration_id_get GET /v1/integrations/{integration_id} Get one integration
IntegrationsApi list_integrations_v1_integrations_get GET /v1/integrations List the portal's provider integrations
IntegrationsApi sync_products_v1_integrations_integration_id_products_sync_post POST /v1/integrations/{integration_id}/products/sync Sync products from one integration's provider
IntegrationsApi test_credentials_v1_integrations_test_post POST /v1/integrations/test Test provider credentials (before saving)
IntegrationsApi test_integration_v1_integrations_integration_id_test_post POST /v1/integrations/{integration_id}/test Test an integration's saved connection
IntegrationsApi update_integration_v1_integrations_integration_id_patch PATCH /v1/integrations/{integration_id} Update an integration (rotate credentials / enable-disable)
ProductsApi count_products_v1_products_count_get GET /v1/products/count Count the portal's products
ProductsApi create_product_v1_products_post POST /v1/products Register a product
ProductsApi delete_product_v1_products_product_id_delete DELETE /v1/products/{product_id} Delete a product
ProductsApi import_products_v1_products_import_post POST /v1/products/import Bulk-add products by hand (upsert a list)
ProductsApi list_products_v1_products_get GET /v1/products List the portal's products (paginated)
ProductsApi sync_all_v1_products_sync_post POST /v1/products/sync Sync products from ALL of the portal's integrations
ProductsApi update_product_v1_products_product_id_patch PATCH /v1/products/{product_id} Edit a product (title / external id / archive-restore)
ServerApi drain_v1_admin_drain_post POST /v1/admin/drain Process queued IPNs then relay pending outbox rows
WebhooksApi ingest_access_v1_ipn_provider_post POST /v1/ipn/{provider} Creator -> student webhooks (access flow)
WebhooksApi ingest_portal_v1_ipn_portal_provider_post POST /v1/ipn/portal/{provider} Portal-plan webhooks (mentortools' own merchant account)

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

ServerName Authorization

Bearer Authorization

Author