rxfoundry.clients.swifty-receiver-api
API for the Swifty Receiver
This Python package is automatically generated by the OpenAPI Generator project:
- API version: 1.16.0.BUILD
- Package version: 1.0.0
- Generator version: 7.13.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
Requirements.
Python 3.9+
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 rxfoundry.clients.swifty_receiver_api
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 rxfoundry.clients.swifty_receiver_api
Tests
Execute pytest to run the tests.
Getting Started
Please follow the installation procedure and then run the following:
import rxfoundry.clients.swifty_receiver_api
from rxfoundry.clients.swifty_receiver_api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to /api
# See configuration.py for a list of all supported configuration parameters.
configuration = rxfoundry.clients.swifty_receiver_api.Configuration(
host = "/api"
)
# 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 HTTP basic authorization: BasicAuth
configuration = rxfoundry.clients.swifty_receiver_api.Configuration(
username = os.environ["USERNAME"],
password = os.environ["PASSWORD"]
)
# Enter a context with an instance of the API client
with rxfoundry.clients.swifty_receiver_api.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = rxfoundry.clients.swifty_receiver_api.AsyncApi(api_client)
message = rxfoundry.clients.swifty_receiver_api.Message() # Message |
try:
# Post a new message asynchronously
api_response = api_instance.create_message(message)
print("The response of AsyncApi->create_message:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling AsyncApi->create_message: %s\n" % e)
Documentation for API Endpoints
All URIs are relative to /api
| Class | Method | HTTP request | Description |
|---|---|---|---|
| AsyncApi | create_message | POST /receiver/1/async/message | Post a new message asynchronously |
| ConnectApi | get_connect | GET /receiver/1/connect | Get the test connection |
| VersionApi | get_version | GET /receiver/1/version | Get the api version |
Documentation For Models
Documentation For Authorization
Authentication schemes defined for the API:
BasicAuth
- Type: HTTP basic authentication
Author
1 maintainer
Release files for rxfoundry.clients.swifty-receiver-api 1.16.0.5441
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| rxfoundry_clients_swifty_receiver_api-1.16.0.5441.tar.gz | 23.8 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| rxfoundry_clients_swifty_receiver_api-1.16.0.5441-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 55.6 kB
Release files / rxfoundry_clients_swifty_receiver_api-1.16.0.5441.tar.gz
| Download URL | rxfoundry_clients_swifty_receiver_api-1.16.0.5441.tar.gz |
|---|---|
| Size | 23.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
55c9efa3c4e3b5e86c2141189f972e06980510abe6595909932e487069c774c6
|
|
BLAKE2b-256 checksum How to use checksums |
d6ad3ca71d21100b015df0a6dd4013c9669631ade869c3f694db944093fc036a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.2.1 CPython/3.12.3 Linux/6.12.94+
|
Release files / rxfoundry_clients_swifty_receiver_api-1.16.0.5441-py3-none-any.whl
| Download URL | rxfoundry_clients_swifty_receiver_api-1.16.0.5441-py3-none-any.whl |
|---|---|
| Size | 31.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
59fd244adecfb038733edc1964d50bc3dbecc9b7bdd7a90c039610fe8ad12956
|
|
BLAKE2b-256 checksum How to use checksums |
5d3c0f4f3bbd2770ad431e8d74193b1b0a58c703ce34763b17959826b3368068
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.2.1 CPython/3.12.3 Linux/6.12.94+
|
