Metadata-Version: 2.4
Name: beckn-python
Version: 0.1.0
Summary: Python SDK for Beckn
Home-page: 
Author: OpenAPI Generator community
Author-email: team@openapitools.org
Requires-Python: >=3.12
Description-Content-Type: text/markdown
Requires-Dist: openapi-generator-cli[jdk4py]>=7.13.0.post0
Requires-Dist: openapi-python-client>=0.24.3
Requires-Dist: openapi-python-generator>=1.2.0
Requires-Dist: pydantic[email]>=2.10.3
Requires-Dist: requests>=2.32.3
Requires-Dist: trustspeccli>=0.1.2
Dynamic: author
Dynamic: author-email

# 
This document contains all the meta API endpoints that are implemented by the network participants. The information returned from these endpoints typically contain cacheable information.

This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 1.1.1
- Package version: 
- Generator version: 7.13.0
- Build package: org.openapitools.codegen.languages.TypeScriptClientCodegen

## Requirements.

Python 

## 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 
```

### 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 
```

### 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 
from .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 = .Configuration(
    host = "http://localhost"
)

# 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: SubscriberAuth
configuration.api_key['SubscriberAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['SubscriberAuth'] = 'Bearer'


# Enter a context with an instance of the API client
with .ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = .BecknApplicationPlatformBPPApi(api_client)
    cancellationReasons = {
    context: null,
    message: {
      cancellationReasons: [
        {
          id: "id_example",
          descriptor: {
            name: "name_example",
            code: "code_example",
            shortDesc: "shortDesc_example",
            longDesc: "longDesc_example",
            additionalDesc: {
              url: "url_example",
              contentType: "text/plain",
            },
            media: [
              {
                mimetype: "mimetype_example",
                url: "url_example",
                signature: "signature_example",
                dsa: "dsa_example",
              },
            ],
            images: [
              {
                url: "url_example",
                sizeType: "xs",
                width: "width_example",
                height: "height_example",
              },
            ],
          },
        },
      ],
    },
  } # CancellationReasons |  (optional)

    try:
        api_instance.cancellationReasonsPost(cancellationReasons=cancellationReasons)
    except ApiException as e:
        print("Exception when calling BecknApplicationPlatformBPPApi->cancellationReasonsPost: %s\n" % e)

```

## Documentation for API Endpoints

All URIs are relative to *http://localhost*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*BecknApplicationPlatformBPPApi* | [**cancellationReasonsPost**](BecknApplicationPlatformBPPApi.md#cancellationreasonspost) | **POST** /cancellation_reasons | 
*BecknApplicationPlatformBPPApi* | [**ratingCategoriesPost**](BecknApplicationPlatformBPPApi.md#ratingcategoriespost) | **POST** /rating_categories | 
*BecknApplicationPlatformBPPApi* | [**returnReasonsPost**](BecknApplicationPlatformBPPApi.md#returnreasonspost) | **POST** /return_reasons | 
*BecknProviderPlatformBPPApi* | [**getCancellationReasonsPost**](BecknProviderPlatformBPPApi.md#getcancellationreasonspost) | **POST** /get_cancellation_reasons | 
*BecknProviderPlatformBPPApi* | [**getRatingCategoriesPost**](BecknProviderPlatformBPPApi.md#getratingcategoriespost) | **POST** /get_rating_categories | 
*BecknProviderPlatformBPPApi* | [**getReturnReasonsPost**](BecknProviderPlatformBPPApi.md#getreturnreasonspost) | **POST** /get_return_reasons | 


## Documentation For Models

 - [Ack](Ack.md)
 - [CancellationReasons](CancellationReasons.md)
 - [CancellationReasonsContext](CancellationReasonsContext.md)
 - [CancellationReasonsMessage](CancellationReasonsMessage.md)
 - [Circle](Circle.md)
 - [City](City.md)
 - [Context](Context.md)
 - [Country](Country.md)
 - [Descriptor](Descriptor.md)
 - [DescriptorAdditionalDesc](DescriptorAdditionalDesc.md)
 - [GetCancellationReasons](GetCancellationReasons.md)
 - [GetCancellationReasonsContext](GetCancellationReasonsContext.md)
 - [GetRatingCategories](GetRatingCategories.md)
 - [GetRatingCategoriesContext](GetRatingCategoriesContext.md)
 - [GetReturnReasons](GetReturnReasons.md)
 - [GetReturnReasonsContext](GetReturnReasonsContext.md)
 - [Image](Image.md)
 - [InlineObject](InlineObject.md)
 - [InlineObjectMessage](InlineObjectMessage.md)
 - [InlineObjectMessageAck](InlineObjectMessageAck.md)
 - [Location](Location.md)
 - [MediaFile](MediaFile.md)
 - [ModelError](ModelError.md)
 - [Option](Option.md)
 - [Rating](Rating.md)
 - [RatingCategories](RatingCategories.md)
 - [RatingCategoriesContext](RatingCategoriesContext.md)
 - [RatingCategoriesMessage](RatingCategoriesMessage.md)
 - [RatingCategory](RatingCategory.md)
 - [ReturnReasons](ReturnReasons.md)
 - [ReturnReasonsContext](ReturnReasonsContext.md)
 - [ReturnReasonsMessage](ReturnReasonsMessage.md)
 - [Scalar](Scalar.md)
 - [ScalarRange](ScalarRange.md)
 - [State](State.md)
 - [Tag](Tag.md)
 - [TagGroup](TagGroup.md)


<a id="documentation-for-authorization"></a>
## Documentation For Authorization


Authentication schemes defined for the API:
<a id="SubscriberAuth"></a>
### SubscriberAuth

- **Type**: API key
- **API key parameter name**: Authorization
- **Location**: HTTP header


## Author




