firestore-otp-verification-api-client

API for managing OTPs using the firestore-otp package

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

• API version: 0.4.0
• Package version: 0.1.0
• Generator version: 7.16.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 firestore_otp_verification_api_client

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 firestore_otp_verification_api_client

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import firestore_otp_verification_api_client
from firestore_otp_verification_api_client.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 = firestore_otp_verification_api_client.Configuration(
    host = "http://0.0.0.0:8080"
)



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

    try:
        # Health Check & Config Info
        api_response = api_instance.root_get()
        print("The response of GeneralApi->root_get:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling GeneralApi->root_get: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
GeneralApi	root_get	GET /	Health Check & Config Info
OTPManagementApi	delete_delete_post	POST /delete	Delete OTP entry
OTPManagementApi	verify_verify_post	POST /verify	Verify OTP code

Documentation For Models

• HTTPValidationError
• HealthConfigResponse
• OtpDeleteRequest
• OtpDeleteResponse
• OtpVerifyRequest
• OtpVerifyResponse
• ValidationError
• ValidationErrorLocInner

Documentation For Authorization

Endpoints do not require authorization.

Author