# nomad-envoy-cli
This is the API descriptor for the Nomad Envoy API, responsible for order operation and product lists. Developed by [Samarkand Global](https://samarkand.global) in partnership with [Youzan](https://www.youzan.com/), [LittleRED](https://www.xiaohongshu.com/), [PDD](http://www.pinduoduo.com/), etc. Read the documentation online at [Nomad API Suite](https://api.samarkand.io/).
- Install for node with `npm install nomad_envoy_cli`
- Install for python with `pip install nomad-envoy-cli`
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 1.57.0
- Package version: 1.57.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
## Requirements.
Python 2.7 and 3.4+
## 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 nomad_envoy_cli
```
### 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 nomad_envoy_cli
```
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
from __future__ import print_function
import time
import nomad_envoy_cli
from nomad_envoy_cli.rest import ApiException
from pprint import pprint
configuration = nomad_envoy_cli.Configuration()
# Configure API key authorization: ca_key
configuration.api_key['x-ca-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-ca-key'] = 'Bearer'
configuration = nomad_envoy_cli.Configuration()
# Configure API key authorization: ca_stage
configuration.api_key['x-ca-stage'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-ca-stage'] = 'Bearer'
# Defining host is optional and default to https://nomad.samarkand-global.cn/envoy
configuration.host = "https://nomad.samarkand-global.cn/envoy"
# Enter a context with an instance of the API client
with nomad_envoy_cli.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = nomad_envoy_cli.CustomsApi(api_client)
region = 'region_example' # str | The region of the customs. e.g. shanghai
order = nomad_envoy_cli.Order() # Order | Order detail
try:
# postCustomsOrder
api_response = api_instance.post_customs_order(region, order)
pprint(api_response)
except ApiException as e:
print("Exception when calling CustomsApi->post_customs_order: %s\n" % e)
```
## Documentation for API Endpoints
All URIs are relative to *https://nomad.samarkand-global.cn/envoy*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*CustomsApi* | [**post_customs_order**](docs/CustomsApi.md#post_customs_order) | **POST** /customs/{region}/order | postCustomsOrder
*CustomsApi* | [**post_customs_payment**](docs/CustomsApi.md#post_customs_payment) | **POST** /customs/{region}/payment | postCustomsPayment
*CustomsApi* | [**post_customs_product**](docs/CustomsApi.md#post_customs_product) | **POST** /customs/{region}/product | postCustomsProduct
*CustomsApi* | [**put_customs_order**](docs/CustomsApi.md#put_customs_order) | **PUT** /customs/{region}/order | putCustomsOrder
*CustomsCallbackApi* | [**post_customs_callback**](docs/CustomsCallbackApi.md#post_customs_callback) | **POST** /customs/{store} | postCustomsCallback
*OrderApi* | [**add_order**](docs/OrderApi.md#add_order) | **POST** /order/{store} | addOrder
*OrderApi* | [**cancel_order**](docs/OrderApi.md#cancel_order) | **DELETE** /order/{store} | cancelOrder
*OrderApi* | [**get_order_by_field**](docs/OrderApi.md#get_order_by_field) | **GET** /order/{store} | getOrderByField
*OrderApi* | [**update_order**](docs/OrderApi.md#update_order) | **PUT** /order/{store} | updateOrder
*ProductApi* | [**add_product**](docs/ProductApi.md#add_product) | **POST** /product/{store} | addProduct
*ProductApi* | [**delete_product**](docs/ProductApi.md#delete_product) | **DELETE** /product/{store} | deleteProduct
*ProductApi* | [**get_products_by_field**](docs/ProductApi.md#get_products_by_field) | **GET** /product/{store} | getProductsByField
*ProductApi* | [**update_product**](docs/ProductApi.md#update_product) | **PUT** /product/{store} | updateProduct
*StoreApi* | [**create_store_inventory**](docs/StoreApi.md#create_store_inventory) | **POST** /stores/{store_id}/inventory | createStoreInventory
*StoreApi* | [**post_store**](docs/StoreApi.md#post_store) | **POST** /stores/ | postStore
*StoreApi* | [**query_store**](docs/StoreApi.md#query_store) | **GET** /stores/ | queryStore
*StoreApi* | [**query_store_inventory**](docs/StoreApi.md#query_store_inventory) | **GET** /stores/{store_id}/inventory | queryStoreInventory
*StoreApi* | [**update_store_inventory**](docs/StoreApi.md#update_store_inventory) | **PUT** /stores/{store_id}/inventory | updateStoreInventory
## Documentation For Models
- [Address](docs/Address.md)
- [ApiResponse](docs/ApiResponse.md)
- [ApiResponseConnectorResponse](docs/ApiResponseConnectorResponse.md)
- [ApiResponseData](docs/ApiResponseData.md)
- [ApiResponseDataRequired](docs/ApiResponseDataRequired.md)
- [ApiResponseGeneral](docs/ApiResponseGeneral.md)
- [ApiResponseInventory](docs/ApiResponseInventory.md)
- [ApiResponseRequired](docs/ApiResponseRequired.md)
- [BaseApiResponse](docs/BaseApiResponse.md)
- [BaseApiResponseData](docs/BaseApiResponseData.md)
- [CustomsDeclarationResult](docs/CustomsDeclarationResult.md)
- [Gender](docs/Gender.md)
- [Images](docs/Images.md)
- [Inventory](docs/Inventory.md)
- [Order](docs/Order.md)
- [OrderApiResponse](docs/OrderApiResponse.md)
- [OrderApiResponseData](docs/OrderApiResponseData.md)
- [OrderApiResponseDataRequired](docs/OrderApiResponseDataRequired.md)
- [OrderApiResponseRequired](docs/OrderApiResponseRequired.md)
- [OrderProduct](docs/OrderProduct.md)
- [Product](docs/Product.md)
- [ProductApiResponse](docs/ProductApiResponse.md)
- [ProductApiResponseData](docs/ProductApiResponseData.md)
- [ProductApiResponseRequired](docs/ProductApiResponseRequired.md)
- [ProductResponseDataRequired](docs/ProductResponseDataRequired.md)
- [ProductSku](docs/ProductSku.md)
- [Store](docs/Store.md)
## Documentation For Authorization
## ca_key
- **Type**: API key
- **API key parameter name**: x-ca-key
- **Location**: HTTP header
## ca_stage
- **Type**: API key
- **API key parameter name**: x-ca-stage
- **Location**: HTTP header
## Author
paul@samarkand.global
Raw data
{
"_id": null,
"home_page": "",
"name": "nomad-envoy-cli",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "OpenAPI,OpenAPI-Generator,Nomad Envoy",
"author": "OpenAPI Generator community",
"author_email": "paul@samarkand.global",
"download_url": "https://files.pythonhosted.org/packages/1e/d6/a71f9128ba52b8b5d2d46e83476177249536889f17e946c3c1feb253c047/nomad-envoy-cli-1.57.0.tar.gz",
"platform": null,
"description": "# nomad-envoy-cli\nThis is the API descriptor for the Nomad Envoy API, responsible for order operation and product lists. Developed by [Samarkand Global](https://samarkand.global) in partnership with [Youzan](https://www.youzan.com/), [LittleRED](https://www.xiaohongshu.com/), [PDD](http://www.pinduoduo.com/), etc. Read the documentation online at [Nomad API Suite](https://api.samarkand.io/).\n- Install for node with `npm install nomad_envoy_cli`\n- Install for python with `pip install nomad-envoy-cli`\n\nThis Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: 1.57.0\n- Package version: 1.57.0\n- Build package: org.openapitools.codegen.languages.PythonClientCodegen\n\n## Requirements.\n\nPython 2.7 and 3.4+\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 nomad_envoy_cli\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 nomad_envoy_cli\n```\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```python\nfrom __future__ import print_function\nimport time\nimport nomad_envoy_cli\nfrom nomad_envoy_cli.rest import ApiException\nfrom pprint import pprint\n\nconfiguration = nomad_envoy_cli.Configuration()\n# Configure API key authorization: ca_key\nconfiguration.api_key['x-ca-key'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['x-ca-key'] = 'Bearer'\nconfiguration = nomad_envoy_cli.Configuration()\n# Configure API key authorization: ca_stage\nconfiguration.api_key['x-ca-stage'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['x-ca-stage'] = 'Bearer'\n\n# Defining host is optional and default to https://nomad.samarkand-global.cn/envoy\nconfiguration.host = \"https://nomad.samarkand-global.cn/envoy\"\n# Enter a context with an instance of the API client\nwith nomad_envoy_cli.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = nomad_envoy_cli.CustomsApi(api_client)\n region = 'region_example' # str | The region of the customs. e.g. shanghai\norder = nomad_envoy_cli.Order() # Order | Order detail\n\n try:\n # postCustomsOrder\n api_response = api_instance.post_customs_order(region, order)\n pprint(api_response)\n except ApiException as e:\n print(\"Exception when calling CustomsApi->post_customs_order: %s\\n\" % e)\n \n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *https://nomad.samarkand-global.cn/envoy*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*CustomsApi* | [**post_customs_order**](docs/CustomsApi.md#post_customs_order) | **POST** /customs/{region}/order | postCustomsOrder\n*CustomsApi* | [**post_customs_payment**](docs/CustomsApi.md#post_customs_payment) | **POST** /customs/{region}/payment | postCustomsPayment\n*CustomsApi* | [**post_customs_product**](docs/CustomsApi.md#post_customs_product) | **POST** /customs/{region}/product | postCustomsProduct\n*CustomsApi* | [**put_customs_order**](docs/CustomsApi.md#put_customs_order) | **PUT** /customs/{region}/order | putCustomsOrder\n*CustomsCallbackApi* | [**post_customs_callback**](docs/CustomsCallbackApi.md#post_customs_callback) | **POST** /customs/{store} | postCustomsCallback\n*OrderApi* | [**add_order**](docs/OrderApi.md#add_order) | **POST** /order/{store} | addOrder\n*OrderApi* | [**cancel_order**](docs/OrderApi.md#cancel_order) | **DELETE** /order/{store} | cancelOrder\n*OrderApi* | [**get_order_by_field**](docs/OrderApi.md#get_order_by_field) | **GET** /order/{store} | getOrderByField\n*OrderApi* | [**update_order**](docs/OrderApi.md#update_order) | **PUT** /order/{store} | updateOrder\n*ProductApi* | [**add_product**](docs/ProductApi.md#add_product) | **POST** /product/{store} | addProduct\n*ProductApi* | [**delete_product**](docs/ProductApi.md#delete_product) | **DELETE** /product/{store} | deleteProduct\n*ProductApi* | [**get_products_by_field**](docs/ProductApi.md#get_products_by_field) | **GET** /product/{store} | getProductsByField\n*ProductApi* | [**update_product**](docs/ProductApi.md#update_product) | **PUT** /product/{store} | updateProduct\n*StoreApi* | [**create_store_inventory**](docs/StoreApi.md#create_store_inventory) | **POST** /stores/{store_id}/inventory | createStoreInventory\n*StoreApi* | [**post_store**](docs/StoreApi.md#post_store) | **POST** /stores/ | postStore\n*StoreApi* | [**query_store**](docs/StoreApi.md#query_store) | **GET** /stores/ | queryStore\n*StoreApi* | [**query_store_inventory**](docs/StoreApi.md#query_store_inventory) | **GET** /stores/{store_id}/inventory | queryStoreInventory\n*StoreApi* | [**update_store_inventory**](docs/StoreApi.md#update_store_inventory) | **PUT** /stores/{store_id}/inventory | updateStoreInventory\n\n\n## Documentation For Models\n\n - [Address](docs/Address.md)\n - [ApiResponse](docs/ApiResponse.md)\n - [ApiResponseConnectorResponse](docs/ApiResponseConnectorResponse.md)\n - [ApiResponseData](docs/ApiResponseData.md)\n - [ApiResponseDataRequired](docs/ApiResponseDataRequired.md)\n - [ApiResponseGeneral](docs/ApiResponseGeneral.md)\n - [ApiResponseInventory](docs/ApiResponseInventory.md)\n - [ApiResponseRequired](docs/ApiResponseRequired.md)\n - [BaseApiResponse](docs/BaseApiResponse.md)\n - [BaseApiResponseData](docs/BaseApiResponseData.md)\n - [CustomsDeclarationResult](docs/CustomsDeclarationResult.md)\n - [Gender](docs/Gender.md)\n - [Images](docs/Images.md)\n - [Inventory](docs/Inventory.md)\n - [Order](docs/Order.md)\n - [OrderApiResponse](docs/OrderApiResponse.md)\n - [OrderApiResponseData](docs/OrderApiResponseData.md)\n - [OrderApiResponseDataRequired](docs/OrderApiResponseDataRequired.md)\n - [OrderApiResponseRequired](docs/OrderApiResponseRequired.md)\n - [OrderProduct](docs/OrderProduct.md)\n - [Product](docs/Product.md)\n - [ProductApiResponse](docs/ProductApiResponse.md)\n - [ProductApiResponseData](docs/ProductApiResponseData.md)\n - [ProductApiResponseRequired](docs/ProductApiResponseRequired.md)\n - [ProductResponseDataRequired](docs/ProductResponseDataRequired.md)\n - [ProductSku](docs/ProductSku.md)\n - [Store](docs/Store.md)\n\n\n## Documentation For Authorization\n\n\n## ca_key\n\n- **Type**: API key\n- **API key parameter name**: x-ca-key\n- **Location**: HTTP header\n\n\n## ca_stage\n\n- **Type**: API key\n- **API key parameter name**: x-ca-stage\n- **Location**: HTTP header\n\n\n## Author\n\npaul@samarkand.global\n\n\n\n\n",
"bugtrack_url": null,
"license": "",
"summary": "Nomad Envoy",
"version": "1.57.0",
"project_urls": null,
"split_keywords": [
"openapi",
"openapi-generator",
"nomad envoy"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1ed6a71f9128ba52b8b5d2d46e83476177249536889f17e946c3c1feb253c047",
"md5": "38b28ca2607083acd4eb2b5755f00b17",
"sha256": "6cfaa923a02c0cf87d52c6e9996a01f95a12a7b1fcf4a2d828a1585389e94cb7"
},
"downloads": -1,
"filename": "nomad-envoy-cli-1.57.0.tar.gz",
"has_sig": false,
"md5_digest": "38b28ca2607083acd4eb2b5755f00b17",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 67474,
"upload_time": "2024-02-27T09:18:52",
"upload_time_iso_8601": "2024-02-27T09:18:52.485455Z",
"url": "https://files.pythonhosted.org/packages/1e/d6/a71f9128ba52b8b5d2d46e83476177249536889f17e946c3c1feb253c047/nomad-envoy-cli-1.57.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-27 09:18:52",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "nomad-envoy-cli"
}
JSON