Skip to main content

Nomad Broker

Project description

nomad-broker-cli

Make payments, and customs declaration for orders.

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

  • API version: 1.4.0
  • Package version: 1.4.0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python >= 3.6

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 nomad_broker_cli

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 nomad_broker_cli

Getting Started

Please follow the installation procedure and then run the following:

import time
import nomad_broker_cli
from pprint import pprint
from nomad_broker_cli.api import customs_api
from nomad_broker_cli.model.api_response import ApiResponse
from nomad_broker_cli.model.customs_code import CustomsCode
from nomad_broker_cli.model.customs_payment_redeclare_request import CustomsPaymentRedeclareRequest
from nomad_broker_cli.model.customs_payment_request import CustomsPaymentRequest
from nomad_broker_cli.model.customs_payment_response import CustomsPaymentResponse
from nomad_broker_cli.model.customs_payments_response import CustomsPaymentsResponse
from nomad_broker_cli.model.customs_request import CustomsRequest
from nomad_broker_cli.model.customs_response import CustomsResponse
from nomad_broker_cli.model.error_api_response import ErrorApiResponse
# Defining the host is optional and defaults to https://nomad.samarkand-global.cn/broker
# See configuration.py for a list of all supported configuration parameters.
configuration = nomad_broker_cli.Configuration(
    host = "https://nomad.samarkand-global.cn/broker"
)

# 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: authorization
configuration.api_key['authorization'] = 'YOUR_API_KEY'

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


# Enter a context with an instance of the API client
with nomad_broker_cli.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = customs_api.CustomsApi(api_client)
    merchant = "guangzhou.prod" # str | Merchant name to payment company, e.g. guangzhou.prod
customs = CustomsCode("GUANGZHOU_ZS") # CustomsCode | Customs code, available options: GUANGZHOU_ZS, HANGZHOU_ZS, NINGBO, ZHENGZHOU_BS, CHONGQING, SHANGHAI_ZS, SHENZHEN, ZHENGZHOU_ZH_ZS
out_trade_no = "out_trade_no_example" # str | The internal order number of the merchant system (optional)
transaction_id = "transaction_id_example" # str | Payment system internal order number (optional)
sub_order_no = "sub_order_no_example" # str | The internal sub-order number of the merchant system (optional)
sub_order_id = "sub_order_id_example" # str | The internal sub-order number of the WeChat payment system (optional)

    try:
        # GetCustomsPayment
        api_response = api_instance.get_customs_payment(merchant, customs, out_trade_no=out_trade_no, transaction_id=transaction_id, sub_order_no=sub_order_no, sub_order_id=sub_order_id)
        pprint(api_response)
    except nomad_broker_cli.ApiException as e:
        print("Exception when calling CustomsApi->get_customs_payment: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://nomad.samarkand-global.cn/broker

Class Method HTTP request Description
CustomsApi get_customs_payment GET /customs/payment/{merchant} GetCustomsPayment
CustomsApi post_customs POST /declare PostCustoms
CustomsApi post_customs_payment POST /customs/payment/{merchant} PostCustomsPayment
CustomsApi put_customs_payment PUT /customs/payment/{merchant} PutCustomsPayment
PayApi pay_post POST /pay
PaymentApi close_payment POST /payment/close/{merchant}/{order_ref} ClosePayment
PaymentApi create_payment POST /payment/{merchant} CreatePayment
PaymentApi invoke_payment POST /payment/invocation/{merchant} InvokePayment
PaymentApi query_payment GET /payment/query/{merchant}/{order_ref} QueryPayment
YouzanApi declare_order_youzan_post POST /declare-order/youzan
YouzanApi query_order_youzan_post POST /query-order/youzan

Documentation For Models

Documentation For Authorization

authorization

  • Type: API key
  • API key parameter name: app-api-key
  • Location: URL query string

Author

manwei@samarkand.global

Notes for Large OpenAPI documents

If the OpenAPI document is large, imports in nomad_broker_cli.apis and nomad_broker_cli.models may fail with a RecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions:

Solution 1: Use specific imports for apis and models like:

  • from nomad_broker_cli.api.default_api import DefaultApi
  • from nomad_broker_cli.model.pet import Pet

Solution 1: Before importing the package, adjust the maximum recursion limit as shown below:

import sys
sys.setrecursionlimit(1500)
import nomad_broker_cli
from nomad_broker_cli.apis import *
from nomad_broker_cli.models import *

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nomad-broker-cli-1.4.0.tar.gz (54.7 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page