Python client library for the Noyes API
Project description
NysClient
A Python client library for the Noyes API.
Installation
pip install nys-client
Usage
from nys_client import NysClient, TriggerStatus
# Initialize client
client = NysClient(api_key="your_api_key")
# Get requests with filtering
requests = client.requests.list(
status="ACCEPTED",
type="FULFILLMENT",
sort_by="created_at",
)
# Create a new request
new_request = client.requests.create(
type="FULFILLMENT",
priority=10,
entities=[{
"entity_type": "SKU",
"sku_id": "SKU123",
"quantity": 1
}]
)
# Get jobs with search
jobs = client.jobs.list(
quick_search="PICKING",
status="EXECUTING"
)
# Trigger a job
client.trigger_job(
job_id="job-uuid",
trigger_status=TriggerStatus.SUCCEEDED_TRIGGER
)
Development
This package is part of the Noyes monorepo. To install in development mode:
pip install -e .
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
nys_client-0.1.0.tar.gz
(12.7 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file nys_client-0.1.0.tar.gz.
File metadata
- Download URL: nys_client-0.1.0.tar.gz
- Upload date:
- Size: 12.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.10.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a403c0a9b68ea490778737ef356bed7795418cee6b1f934bad8c419d511685f5
|
|
| MD5 |
8343ea1037f4fb2bc02c3861e9a717bf
|
|
| BLAKE2b-256 |
0004f5a6ab5ba3f332d7db08ca2975222058caff9e64edbe3ddf0e82c963e06d
|
File details
Details for the file nys_client-0.1.0-py3-none-any.whl.
File metadata
- Download URL: nys_client-0.1.0-py3-none-any.whl
- Upload date:
- Size: 18.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.10.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
fa14b2a821b9fc0773307406067cc09a512f211923e576f5a793e5f41cc9cd79
|
|
| MD5 |
97ee43d2a7aaf188e5f3ab92d6d3e4e0
|
|
| BLAKE2b-256 |
371193fed97ec988dfdced5eadf8a88d64d472b000d559454a72df8c9f56a0f6
|