# cashfree-lrs-client
CashFree LRS APIs (v2)
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 1.0.17
- Package version: 1.0.17
- Build package: org.openapitools.codegen.languages.PythonNextgenClientCodegen
For more information, please visit [https://docs.cashfree.com](https://docs.cashfree.com)
## 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 cashfree_lrs_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 cashfree_lrs_client
```
### Tests
Execute `pytest` to run the tests.
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
import time
import cashfree_lrs_client
from cashfree_lrs_client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://sandbox.cashfree.com/pg/lrs
# See configuration.py for a list of all supported configuration parameters.
configuration = cashfree_lrs_client.Configuration(
host = "https://sandbox.cashfree.com/pg/lrs"
)
# 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 API key authorization: X-Client-ID
configuration.api_key['X-Client-ID'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Client-ID'] = 'Bearer'
# Configure API key authorization: X-Client-Secret
configuration.api_key['X-Client-Secret'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Client-Secret'] = 'Bearer'
# Configure API key authorization: X-API-Version
configuration.api_key['X-API-Version'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-Version'] = 'Bearer'
# Enter a context with an instance of the API client
with cashfree_lrs_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = cashfree_lrs_client.LrsApi(api_client)
files = None # List[bytearray] | Upload multiple document at a time. Accepted file type - .pdf. Maximum file size - 20 MB
try:
# Upload Documents in Bulk
api_response = api_instance.bulk_documents_upload(files)
print("The response of LrsApi->bulk_documents_upload:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling LrsApi->bulk_documents_upload: %s\n" % e)
```
## Documentation for API Endpoints
All URIs are relative to *https://sandbox.cashfree.com/pg/lrs*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*LrsApi* | [**bulk_documents_upload**](docs/LrsApi.md#bulk_documents_upload) | **POST** /orders/documents/upload | Upload Documents in Bulk
*LrsApi* | [**create_beneficiary**](docs/LrsApi.md#create_beneficiary) | **POST** /beneficiaries | Create Beneficiary
*LrsApi* | [**create_order**](docs/LrsApi.md#create_order) | **POST** /orders | Create LRS Order
*LrsApi* | [**create_remitter**](docs/LrsApi.md#create_remitter) | **POST** /remitters | Create Remitter
*LrsApi* | [**fetch_forex_rate**](docs/LrsApi.md#fetch_forex_rate) | **POST** /fx-rate/details | Fetch FX Rate
*LrsApi* | [**process_order**](docs/LrsApi.md#process_order) | **POST** /orders/{order_id}/process | Process Order
*LrsApi* | [**setup_webhooks**](docs/LrsApi.md#setup_webhooks) | **POST** /webhooks | Setup Webhooks
*LrsApi* | [**upload_documents**](docs/LrsApi.md#upload_documents) | **POST** /orders/{order_id}/documents/upload | Upload Documents
## Documentation For Models
- [BulkDocumentsUploadResponse](docs/BulkDocumentsUploadResponse.md)
- [Country](docs/Country.md)
- [CreateBeneficiaryRequest](docs/CreateBeneficiaryRequest.md)
- [CreateOrderRequest](docs/CreateOrderRequest.md)
- [CreateOrderResponse](docs/CreateOrderResponse.md)
- [CreateRemitterRequest](docs/CreateRemitterRequest.md)
- [Currency](docs/Currency.md)
- [Document](docs/Document.md)
- [Error](docs/Error.md)
- [FetchForexRateRequest](docs/FetchForexRateRequest.md)
- [FetchForexRateResponse](docs/FetchForexRateResponse.md)
- [FetchForexRateResponseTcs](docs/FetchForexRateResponseTcs.md)
- [Purpose](docs/Purpose.md)
- [SetupWebhooksRequest](docs/SetupWebhooksRequest.md)
- [SuccessMessage](docs/SuccessMessage.md)
<a id="documentation-for-authorization"></a>
## Documentation For Authorization
Authentication schemes defined for the API:
<a id="X-API-Version"></a>
### X-API-Version
- **Type**: API key
- **API key parameter name**: X-API-Version
- **Location**: HTTP header
<a id="X-Client-ID"></a>
### X-Client-ID
- **Type**: API key
- **API key parameter name**: X-Client-ID
- **Location**: HTTP header
<a id="X-Client-Secret"></a>
### X-Client-Secret
- **Type**: API key
- **API key parameter name**: X-Client-Secret
- **Location**: HTTP header
## Author
nextgenapi@cashfree.com
Raw data
{
"_id": null,
"home_page": "https://github.com/GIT_USER_ID/GIT_REPO_ID",
"name": "cashfree-lrs-client",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7,<4.0",
"maintainer_email": "",
"keywords": "OpenAPI,OpenAPI-Generator,Cashfree LRS",
"author": "CashFree Care",
"author_email": "nextgenapi@cashfree.com",
"download_url": "https://files.pythonhosted.org/packages/f7/3a/44ca79f08626ab36ec2635957b110d316544ac6aa17bc080b020d988433a/cashfree_lrs_client-1.0.17.tar.gz",
"platform": null,
"description": "# cashfree-lrs-client\nCashFree LRS APIs (v2)\n\nThis Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: 1.0.17\n- Package version: 1.0.17\n- Build package: org.openapitools.codegen.languages.PythonNextgenClientCodegen\nFor more information, please visit [https://docs.cashfree.com](https://docs.cashfree.com)\n\n## Requirements.\n\nPython 3.7+\n\n## Installation & Usage\n### pip install\n\nIf the python package is hosted on a repository, you can install directly using:\n\n```sh\npip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git\n```\n(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)\n\nThen import the package:\n```python\nimport cashfree_lrs_client\n```\n\n### Setuptools\n\nInstall via [Setuptools](http://pypi.python.org/pypi/setuptools).\n\n```sh\npython setup.py install --user\n```\n(or `sudo python setup.py install` to install the package for all users)\n\nThen import the package:\n```python\nimport cashfree_lrs_client\n```\n\n### Tests\n\nExecute `pytest` to run the tests.\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```python\n\nimport time\nimport cashfree_lrs_client\nfrom cashfree_lrs_client.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to https://sandbox.cashfree.com/pg/lrs\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = cashfree_lrs_client.Configuration(\n host = \"https://sandbox.cashfree.com/pg/lrs\"\n)\n\n# The client must configure the authentication and authorization parameters\n# in accordance with the API server security policy.\n# Examples for each auth method are provided below, use the example that\n# satisfies your auth use case.\n\n# Configure API key authorization: X-Client-ID\nconfiguration.api_key['X-Client-ID'] = os.environ[\"API_KEY\"]\n\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['X-Client-ID'] = 'Bearer'\n\n# Configure API key authorization: X-Client-Secret\nconfiguration.api_key['X-Client-Secret'] = os.environ[\"API_KEY\"]\n\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['X-Client-Secret'] = 'Bearer'\n\n# Configure API key authorization: X-API-Version\nconfiguration.api_key['X-API-Version'] = os.environ[\"API_KEY\"]\n\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['X-API-Version'] = 'Bearer'\n\n\n# Enter a context with an instance of the API client\nwith cashfree_lrs_client.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = cashfree_lrs_client.LrsApi(api_client)\n files = None # List[bytearray] | Upload multiple document at a time. Accepted file type - .pdf. Maximum file size - 20 MB\n\n try:\n # Upload Documents in Bulk\n api_response = api_instance.bulk_documents_upload(files)\n print(\"The response of LrsApi->bulk_documents_upload:\\n\")\n pprint(api_response)\n except ApiException as e:\n print(\"Exception when calling LrsApi->bulk_documents_upload: %s\\n\" % e)\n\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *https://sandbox.cashfree.com/pg/lrs*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*LrsApi* | [**bulk_documents_upload**](docs/LrsApi.md#bulk_documents_upload) | **POST** /orders/documents/upload | Upload Documents in Bulk\n*LrsApi* | [**create_beneficiary**](docs/LrsApi.md#create_beneficiary) | **POST** /beneficiaries | Create Beneficiary\n*LrsApi* | [**create_order**](docs/LrsApi.md#create_order) | **POST** /orders | Create LRS Order\n*LrsApi* | [**create_remitter**](docs/LrsApi.md#create_remitter) | **POST** /remitters | Create Remitter\n*LrsApi* | [**fetch_forex_rate**](docs/LrsApi.md#fetch_forex_rate) | **POST** /fx-rate/details | Fetch FX Rate\n*LrsApi* | [**process_order**](docs/LrsApi.md#process_order) | **POST** /orders/{order_id}/process | Process Order\n*LrsApi* | [**setup_webhooks**](docs/LrsApi.md#setup_webhooks) | **POST** /webhooks | Setup Webhooks\n*LrsApi* | [**upload_documents**](docs/LrsApi.md#upload_documents) | **POST** /orders/{order_id}/documents/upload | Upload Documents\n\n\n## Documentation For Models\n\n - [BulkDocumentsUploadResponse](docs/BulkDocumentsUploadResponse.md)\n - [Country](docs/Country.md)\n - [CreateBeneficiaryRequest](docs/CreateBeneficiaryRequest.md)\n - [CreateOrderRequest](docs/CreateOrderRequest.md)\n - [CreateOrderResponse](docs/CreateOrderResponse.md)\n - [CreateRemitterRequest](docs/CreateRemitterRequest.md)\n - [Currency](docs/Currency.md)\n - [Document](docs/Document.md)\n - [Error](docs/Error.md)\n - [FetchForexRateRequest](docs/FetchForexRateRequest.md)\n - [FetchForexRateResponse](docs/FetchForexRateResponse.md)\n - [FetchForexRateResponseTcs](docs/FetchForexRateResponseTcs.md)\n - [Purpose](docs/Purpose.md)\n - [SetupWebhooksRequest](docs/SetupWebhooksRequest.md)\n - [SuccessMessage](docs/SuccessMessage.md)\n\n\n<a id=\"documentation-for-authorization\"></a>\n## Documentation For Authorization\n\n\nAuthentication schemes defined for the API:\n<a id=\"X-API-Version\"></a>\n### X-API-Version\n\n- **Type**: API key\n- **API key parameter name**: X-API-Version\n- **Location**: HTTP header\n\n<a id=\"X-Client-ID\"></a>\n### X-Client-ID\n\n- **Type**: API key\n- **API key parameter name**: X-Client-ID\n- **Location**: HTTP header\n\n<a id=\"X-Client-Secret\"></a>\n### X-Client-Secret\n\n- **Type**: API key\n- **API key parameter name**: X-Client-Secret\n- **Location**: HTTP header\n\n\n## Author\n\nnextgenapi@cashfree.com\n\n\n",
"bugtrack_url": null,
"license": "NoLicense",
"summary": "Cashfree LRS",
"version": "1.0.17",
"project_urls": {
"Homepage": "https://github.com/GIT_USER_ID/GIT_REPO_ID",
"Repository": "https://github.com/GIT_USER_ID/GIT_REPO_ID"
},
"split_keywords": [
"openapi",
"openapi-generator",
"cashfree lrs"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4f52b0a07513650ae465fce666b5d927baa10f6c1332e0fe54f673c6b8248b36",
"md5": "e499e534e19937c85a9777ace7bb5a6e",
"sha256": "1d7a084f028d9f8a43c1fde6bfa35fffc788e876115cf705c8a72c6585a9d534"
},
"downloads": -1,
"filename": "cashfree_lrs_client-1.0.17-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e499e534e19937c85a9777ace7bb5a6e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7,<4.0",
"size": 155224,
"upload_time": "2023-08-08T09:47:21",
"upload_time_iso_8601": "2023-08-08T09:47:21.580281Z",
"url": "https://files.pythonhosted.org/packages/4f/52/b0a07513650ae465fce666b5d927baa10f6c1332e0fe54f673c6b8248b36/cashfree_lrs_client-1.0.17-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f73a44ca79f08626ab36ec2635957b110d316544ac6aa17bc080b020d988433a",
"md5": "725b89a7c402a3b6a512bf181901dada",
"sha256": "4a629d7e5ff34359d4cc95e729b28d9bd11f619644a98fa651f083397a3516d4"
},
"downloads": -1,
"filename": "cashfree_lrs_client-1.0.17.tar.gz",
"has_sig": false,
"md5_digest": "725b89a7c402a3b6a512bf181901dada",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7,<4.0",
"size": 71650,
"upload_time": "2023-08-08T09:47:22",
"upload_time_iso_8601": "2023-08-08T09:47:22.715898Z",
"url": "https://files.pythonhosted.org/packages/f7/3a/44ca79f08626ab36ec2635957b110d316544ac6aa17bc080b020d988433a/cashfree_lrs_client-1.0.17.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-08 09:47:22",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "GIT_USER_ID",
"github_project": "GIT_REPO_ID",
"github_not_found": true,
"lcname": "cashfree-lrs-client"
}
JSON
