https://github.com/jong/moneylion-openapi-client
generated openapi client for MoneyLion API`
https://github.com/jong/moneylion-openapi-client
Last synced: 4 months ago
JSON representation
generated openapi client for MoneyLion API`
- Host: GitHub
- URL: https://github.com/jong/moneylion-openapi-client
- Owner: jong
- Created: 2024-08-21T22:38:12.000Z (over 1 year ago)
- Default Branch: develop
- Last Pushed: 2024-08-21T22:43:46.000Z (over 1 year ago)
- Last Synced: 2025-02-07T21:19:27.797Z (about 1 year ago)
- Size: 263 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# openapi-client
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 1.58.0
- Package version: 1.0.0
- Generator version: 7.8.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
For more information, please visit [https://engine.tech/docs](https://engine.tech/docs)
## Requirements.
Python 3.7+
## Installation & Usage
### pip install
If the python package is hosted on a repository, you can install directly using:
```sh
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:
```python
import openapi_client
```
### Setuptools
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)
Then import the package:
```python
import openapi_client
```
### Tests
Execute `pytest` to run the tests.
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.engine.tech
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
host = "https://api.engine.tech"
)
# 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: confidentialBearerToken
configuration = openapi_client.Configuration(
access_token = os.environ["BEARER_TOKEN"]
)
# Enter a context with an instance of the API client
with openapi_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = openapi_client.AnalyticsApi(api_client)
timestamp = '2013-10-20T19:20:30+01:00' # datetime | The lower bound for when an event hit Engine by MoneyLion's system.
try:
# Get lead client tags
api_response = api_instance.get_lead_client_tags(timestamp)
print("The response of AnalyticsApi->get_lead_client_tags:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling AnalyticsApi->get_lead_client_tags: %s\n" % e)
```
## Documentation for API Endpoints
All URIs are relative to *https://api.engine.tech*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*AnalyticsApi* | [**get_lead_client_tags**](docs/AnalyticsApi.md#get_lead_client_tags) | **GET** /supplyAnalytics/leadClientTags | Get lead client tags
*AnalyticsApi* | [**get_lead_events**](docs/AnalyticsApi.md#get_lead_events) | **GET** /supplyAnalytics/leadEvents | Get lead events
*AnalyticsApi* | [**get_lead_payouts**](docs/AnalyticsApi.md#get_lead_payouts) | **GET** /supplyAnalytics/leadPayouts | Get lead payouts
*ApprovalProbabilityApi* | [**create_loans_approval_probability_report**](docs/ApprovalProbabilityApi.md#create_loans_approval_probability_report) | **POST** /approvalProbability/loanReports | Get a loan approval probability report
*ApprovalProbabilityApi* | [**get_loans_approval_probability_report**](docs/ApprovalProbabilityApi.md#get_loans_approval_probability_report) | **GET** /approvalProbability/loanReports/{uuid} | Get approval probability loan report
*LeadApi* | [**get_lead**](docs/LeadApi.md#get_lead) | **GET** /leads/{uuid} | Get lead
*LeadApi* | [**get_rate_table**](docs/LeadApi.md#get_rate_table) | **GET** /originator/rateTables/{uuid} | Get rate table
*LeadApi* | [**get_rate_table_for_specified_lead**](docs/LeadApi.md#get_rate_table_for_specified_lead) | **POST** /leads/{leadUuid}/rateTables | Submit a lead and get a rate table
*LeadApi* | [**submit_lead**](docs/LeadApi.md#submit_lead) | **POST** /leads/rateTables | Submit lead
*LeadApi* | [**update_lead**](docs/LeadApi.md#update_lead) | **PATCH** /leads/{uuid} | Update a lead
*OfferPreviewApi* | [**get_preview_credit_card_offers**](docs/OfferPreviewApi.md#get_preview_credit_card_offers) | **GET** /offerPreview/creditCardOffers | Get preview credit card offers
*OfferPreviewApi* | [**get_preview_loan_offers**](docs/OfferPreviewApi.md#get_preview_loan_offers) | **GET** /offerPreview/loanOffers | Get preview loan offers
*OfferPreviewApi* | [**get_preview_savings_offers**](docs/OfferPreviewApi.md#get_preview_savings_offers) | **GET** /offerPreview/savingsOffers | Get preview savings offers
*UIEventsApi* | [**create_offer_display**](docs/UIEventsApi.md#create_offer_display) | **POST** /uiEvent/offerDisplays | Record offer display
*UIEventsApi* | [**create_session_init**](docs/UIEventsApi.md#create_session_init) | **POST** /uiEvent/sessionInits | Record new session
*UIUtilsApi* | [**get_featured_financial_institutions**](docs/UIUtilsApi.md#get_featured_financial_institutions) | **GET** /uiUtil/featuredFinancialInstitutions | Get featured financial institutions
*UIUtilsApi* | [**get_universities**](docs/UIUtilsApi.md#get_universities) | **GET** /leads/universities | Get university names
*UIUtilsApi* | [**get_vehicle_makes**](docs/UIUtilsApi.md#get_vehicle_makes) | **GET** /leads/vehicles/makes | Get vehicle makes
*UIUtilsApi* | [**get_vehicle_models**](docs/UIUtilsApi.md#get_vehicle_models) | **GET** /leads/vehicles/models | Get vehicle models
*UIUtilsApi* | [**get_vehicle_trims**](docs/UIUtilsApi.md#get_vehicle_trims) | **GET** /leads/vehicles/trims | Get vehicle trims
*UIUtilsApi* | [**get_vehicle_years**](docs/UIUtilsApi.md#get_vehicle_years) | **GET** /leads/vehicles/years | Get vehicle years
## Documentation For Models
- [ApiApprovedEventData](docs/ApiApprovedEventData.md)
- [ApiError](docs/ApiError.md)
- [ApiRejectedEventData](docs/ApiRejectedEventData.md)
- [AppliedEventData](docs/AppliedEventData.md)
- [ApprovedEventData](docs/ApprovedEventData.md)
- [AprType](docs/AprType.md)
- [BankAccountType](docs/BankAccountType.md)
- [CardBenefit](docs/CardBenefit.md)
- [CardPurpose](docs/CardPurpose.md)
- [CardType](docs/CardType.md)
- [CarrierDecisionType](docs/CarrierDecisionType.md)
- [CitizenshipStatus](docs/CitizenshipStatus.md)
- [CompoundingMethod](docs/CompoundingMethod.md)
- [ConversionEventData](docs/ConversionEventData.md)
- [CreditCardOffer](docs/CreditCardOffer.md)
- [CreditCardOfferDetails](docs/CreditCardOfferDetails.md)
- [EducationLevel](docs/EducationLevel.md)
- [EmploymentPayFrequency](docs/EmploymentPayFrequency.md)
- [EmploymentStatus](docs/EmploymentStatus.md)
- [EventData](docs/EventData.md)
- [EventType](docs/EventType.md)
- [FeaturedFinancialInstitution](docs/FeaturedFinancialInstitution.md)
- [FederalInsuranceType](docs/FederalInsuranceType.md)
- [FinancialInstitutionLoanReport](docs/FinancialInstitutionLoanReport.md)
- [FundedEventData](docs/FundedEventData.md)
- [Gender](docs/Gender.md)
- [GraduateDegreeType](docs/GraduateDegreeType.md)
- [IdType](docs/IdType.md)
- [IncentiveDetails](docs/IncentiveDetails.md)
- [IncentiveType](docs/IncentiveType.md)
- [IncentiveUnit](docs/IncentiveUnit.md)
- [IntroOfferType](docs/IntroOfferType.md)
- [Lead](docs/Lead.md)
- [LeadAction](docs/LeadAction.md)
- [LeadActionType](docs/LeadActionType.md)
- [LeadAutoInsuranceInformation](docs/LeadAutoInsuranceInformation.md)
- [LeadBestTimeToCall](docs/LeadBestTimeToCall.md)
- [LeadClientTag](docs/LeadClientTag.md)
- [LeadClientTagsResponse](docs/LeadClientTagsResponse.md)
- [LeadCoApplicantInformation](docs/LeadCoApplicantInformation.md)
- [LeadCreateData](docs/LeadCreateData.md)
- [LeadCreditCardInformation](docs/LeadCreditCardInformation.md)
- [LeadCreditInformation](docs/LeadCreditInformation.md)
- [LeadEducationInformation](docs/LeadEducationInformation.md)
- [LeadEmploymentInformation](docs/LeadEmploymentInformation.md)
- [LeadEvent](docs/LeadEvent.md)
- [LeadEventResponse](docs/LeadEventResponse.md)
- [LeadFinancialInformation](docs/LeadFinancialInformation.md)
- [LeadHealthInformation](docs/LeadHealthInformation.md)
- [LeadIdentificationInformation](docs/LeadIdentificationInformation.md)
- [LeadLegalInformation](docs/LeadLegalInformation.md)
- [LeadLoanInformation](docs/LeadLoanInformation.md)
- [LeadMortgageInformation](docs/LeadMortgageInformation.md)
- [LeadPayout](docs/LeadPayout.md)
- [LeadPayoutResponse](docs/LeadPayoutResponse.md)
- [LeadPersonalInformation](docs/LeadPersonalInformation.md)
- [LeadSavingsInformation](docs/LeadSavingsInformation.md)
- [LeadSessionInformation](docs/LeadSessionInformation.md)
- [LeadUuid](docs/LeadUuid.md)
- [LifeInsuranceOffer](docs/LifeInsuranceOffer.md)
- [LifeInsuranceOfferDetails](docs/LifeInsuranceOfferDetails.md)
- [ListedEventData](docs/ListedEventData.md)
- [LoanOffer](docs/LoanOffer.md)
- [LoanProbability](docs/LoanProbability.md)
- [LoanPurpose](docs/LoanPurpose.md)
- [LoanReport](docs/LoanReport.md)
- [LoanReportCreateData](docs/LoanReportCreateData.md)
- [MedicalExam](docs/MedicalExam.md)
- [MortgageAdjustmentType](docs/MortgageAdjustmentType.md)
- [MortgageLoanType](docs/MortgageLoanType.md)
- [MortgageOffer](docs/MortgageOffer.md)
- [MortgageOfferDetails](docs/MortgageOfferDetails.md)
- [MortgageType](docs/MortgageType.md)
- [OccupancyType](docs/OccupancyType.md)
- [Offer](docs/Offer.md)
- [OfferClickedEventData](docs/OfferClickedEventData.md)
- [OfferDisplay](docs/OfferDisplay.md)
- [OfferDisplayCreateData](docs/OfferDisplayCreateData.md)
- [OpenedEventData](docs/OpenedEventData.md)
- [Originator](docs/Originator.md)
- [OriginatorImage](docs/OriginatorImage.md)
- [PackageType](docs/PackageType.md)
- [Partner](docs/Partner.md)
- [PendingResponse](docs/PendingResponse.md)
- [PersonalReferenceInformation](docs/PersonalReferenceInformation.md)
- [PersonalReferenceRelationType](docs/PersonalReferenceRelationType.md)
- [ProductSubType](docs/ProductSubType.md)
- [ProductType](docs/ProductType.md)
- [PropertySearchStatus](docs/PropertySearchStatus.md)
- [PropertyStatus](docs/PropertyStatus.md)
- [PropertyType](docs/PropertyType.md)
- [ProvidedCreditRating](docs/ProvidedCreditRating.md)
- [PurchaseStatus](docs/PurchaseStatus.md)
- [RateTable](docs/RateTable.md)
- [RefinanceLoanInformation](docs/RefinanceLoanInformation.md)
- [RefinanceLoanType](docs/RefinanceLoanType.md)
- [RefinanceType](docs/RefinanceType.md)
- [RejectReason](docs/RejectReason.md)
- [SavingsOffer](docs/SavingsOffer.md)
- [SavingsOfferDetails](docs/SavingsOfferDetails.md)
- [SessionInit](docs/SessionInit.md)
- [SessionInitCreateData](docs/SessionInitCreateData.md)
- [SpecialOffer](docs/SpecialOffer.md)
- [State](docs/State.md)
- [TermUnit](docs/TermUnit.md)
- [VehicleDetails](docs/VehicleDetails.md)
- [VehicleInformation](docs/VehicleInformation.md)
## Documentation For Authorization
Authentication schemes defined for the API:
### publishableBearerToken
- **Type**: Bearer authentication
- **Type**: Bearer authentication
- **Type**: Bearer authentication
## Author
help@engine.tech