marax_server_sdk
Project description
marax_server_sdk
Marax Server SDK to send transactional events from client server to marax server
This Python package is automatically generated by the OpenAPI Generator project:
- API version: 0.2.0
- Package version: 0.2.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
Requirements.
Python 2.7 and 3.4+
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 marax_server_sdk
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 marax_server_sdk
Getting Started
Please follow the installation procedure and then run the following:
from __future__ import print_function
import time
import marax_server_sdk
from marax_server_sdk.rest import ApiException
from pprint import pprint
configuration = marax_server_sdk.Configuration()
# Configure API key authorization: ApiKeyAuth
configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'
# Defining host is optional and default to https://<client-name>.marax.ai
configuration.host = "https://<client-name>.marax.ai"
# Enter a context with an instance of the API client
with marax_server_sdk.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = marax_server_sdk.RewardApi(api_client)
request_body = marax_server_sdk.RequestBody() # RequestBody | Details of transactional event (optional)
try:
# Perform reward post-processing
api_response = api_instance.process_event(request_body=request_body)
pprint(api_response)
except ApiException as e:
print("Exception when calling RewardApi->process_event: %s\n" % e)
Documentation for API Endpoints
All URIs are relative to https://<client-name>.marax.ai
Class | Method | HTTP request | Description |
---|---|---|---|
RewardApi | process_event | POST /event/process | Perform reward post-processing |
Documentation For Models
- RequestBody
- RequestBodyProperties
- RequestBodyPropertiesFulfillment
- RequestBodyPropertiesProducts
- RequestBodyPropertiesReward
- RequestBodyPropertiesTotalCartPrice
- RequestBodyPropertiesTotalDiscount
- RequestBodyPropertiesTotalOrderPrice
- Response200
- Response400
- Response500
Documentation For Authorization
ApiKeyAuth
- Type: API key
- API key parameter name: X-API-KEY
- Location: HTTP header
Author
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for marax_server_sdk-0.3.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4dc58e4faf7ded43aeec1b44f2f10c748d37c074c88c295035fec8e7be373b88 |
|
MD5 | fa78fb9a38a87c87c60b444d6ecd746f |
|
BLAKE2b-256 | 68d186519d5edf48851f83533eb765b82627fecddbc49b90a0a63dbdaf353033 |