board-mate.sms
boardmate_api API
This Python package is automatically generated by the OpenAPI Generator project:
- API version: 1.0.0
- Package version: 1.0.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
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 board_mate.sms
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 board_mate.sms
Tests
Execute pytest to run the tests.
Getting Started
Please follow the installation procedure and then run the following:
import time
import board_mate.sms
from board_mate.sms.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://boardmate_api
# See configuration.py for a list of all supported configuration parameters.
configuration = board_mate.sms.Configuration(
host = "https://boardmate_api"
)
# Enter a context with an instance of the API client
with board_mate.sms.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = board_mate.sms.DefaultApi(api_client)
body = 'body_example' # str |
try:
# POST sms/send
api_response = api_instance.example(body)
print("The response of DefaultApi->example:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling DefaultApi->example: %s\n" % e)
Documentation for API Endpoints
All URIs are relative to https://boardmate_api
| Class | Method | HTTP request | Description |
|---|---|---|---|
| DefaultApi | example | POST /sms/send | POST sms/send |
Documentation For Models
Documentation For Authorization
Endpoints do not require authorization.