beckn-python 0.1.0

Python SDK for Beckn

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 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:

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 

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 

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

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	POST /cancellation_reasons
BecknApplicationPlatformBPPApi	ratingCategoriesPost	POST /rating_categories
BecknApplicationPlatformBPPApi	returnReasonsPost	POST /return_reasons
BecknProviderPlatformBPPApi	getCancellationReasonsPost	POST /get_cancellation_reasons
BecknProviderPlatformBPPApi	getRatingCategoriesPost	POST /get_rating_categories
BecknProviderPlatformBPPApi	getReturnReasonsPost	POST /get_return_reasons

Documentation For Models

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

Documentation For Authorization

Authentication schemes defined for the API:

SubscriberAuth

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header

Author