mentortools/libs/: marketplace-server-connector-v2-1.0.0+2656332099 metadata and description
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 |
|
| requires_dist |
|
| requires_python | >=3.9 |
| File | Tox results | History |
|---|---|---|
marketplace_server_connector_v2-1.0.0+2656332099-py3-none-any.whl
|
|
|
marketplace_server_connector_v2-1.0.0+2656332099.tar.gz
|
|
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:
- API version: 0.1.0
- Package version: 1.0.0+2656332099
- Generator version: 7.23.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
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"
)
# 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: Bearer Authorization
configuration = marketplace_server_connector_v2.Configuration(
access_token = os.environ["BEARER_TOKEN"]
)
# Configure API key authorization: ServerName Authorization
configuration.api_key['ServerName Authorization'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ServerName Authorization'] = 'Bearer'
# 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.AdminApi(api_client)
try:
# Process queued IPNs then relay pending outbox rows
api_response = await api_instance.drain_v1_admin_drain_post()
print("The response of AdminApi->drain_v1_admin_drain_post:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling AdminApi->drain_v1_admin_drain_post: %s\n" % e)
Documentation for API Endpoints
All URIs are relative to http://localhost
| Class | Method | HTTP request | Description |
|---|---|---|---|
| AdminApi | drain_v1_admin_drain_post | POST /v1/admin/drain | Process queued IPNs then relay pending outbox rows |
| AdminApi | health_health_get | GET /health | Health check |
| CatalogApi | count_products_v1_catalog_products_count_get | GET /v1/catalog/products/count | Count the portal's marketplace products |
| CatalogApi | create_account_v1_catalog_accounts_post | POST /v1/catalog/accounts | Connect a provider account |
| CatalogApi | create_product_v1_catalog_products_post | POST /v1/catalog/products | Register a marketplace product |
| CatalogApi | delete_account_v1_catalog_accounts_account_id_delete | DELETE /v1/catalog/accounts/{account_id} | Disconnect (delete) an account |
| CatalogApi | delete_product_v1_catalog_products_product_id_delete | DELETE /v1/catalog/products/{product_id} | Delete a product |
| CatalogApi | get_account_v1_catalog_accounts_account_id_get | GET /v1/catalog/accounts/{account_id} | Get one connected account |
| CatalogApi | import_products_v1_catalog_products_import_post | POST /v1/catalog/products/import | Bulk-add products by hand (upsert a list) |
| CatalogApi | list_accounts_v1_catalog_accounts_get | GET /v1/catalog/accounts | List the portal's connected provider accounts |
| CatalogApi | list_products_v1_catalog_products_get | GET /v1/catalog/products | List the portal's marketplace products (paginated) |
| CatalogApi | sync_account_products_v1_catalog_accounts_account_id_products_sync_post | POST /v1/catalog/accounts/{account_id}/products/sync | Sync products from one provider account |
| CatalogApi | sync_all_products_v1_catalog_products_sync_post | POST /v1/catalog/products/sync | Sync products from ALL of the portal's provider accounts |
| CatalogApi | update_account_v1_catalog_accounts_account_id_patch | PATCH /v1/catalog/accounts/{account_id} | Update an account (rotate credentials / enable-disable) |
| CatalogApi | update_product_v1_catalog_products_product_id_patch | PATCH /v1/catalog/products/{product_id} | Edit a product (title / external id / archive-restore) |
| IpnApi | ingest_access_v1_ipn_provider_post | POST /v1/ipn/{provider} | Creator -> student webhooks (access flow) |
| IpnApi | ingest_portal_v1_ipn_portal_provider_post | POST /v1/ipn/portal/{provider} | Portal-plan webhooks (mentortools' own merchant account) |
Documentation For Models
- AccountIn
- AccountOut
- AccountPatchIn
- AccountSyncOut
- DrainOut
- Flow
- HTTPValidationError
- HealthOut
- IdOut
- IpnAcceptedOut
- LocationInner
- ProductIn
- ProductItemIn
- ProductOut
- ProductPatchIn
- ProductsImportIn
- ProductsImportOut
- Provider
- ValidationError
- WrappedResponseAccountOut
- WrappedResponseAccountSyncOut
- WrappedResponseDrainOut
- WrappedResponseHealthOut
- WrappedResponseIdOut
- WrappedResponseInt
- WrappedResponseIpnAcceptedOut
- WrappedResponseListAccountOut
- WrappedResponseListAccountSyncOut
- WrappedResponseListProductOut
- WrappedResponseProductsImportOut
Documentation For Authorization
Authentication schemes defined for the API:
ServerName Authorization
- Type: API key
- API key parameter name: server_name
- Location: HTTP header
Bearer Authorization
- Type: Bearer authentication