omnicommerce 0.1.1__tar.gz

omnicommerce-0.1.1/.gitignore

@@ -0,0 +1,73 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+node_modules/
+/infrastructure/document-worker/.venv
+scripts/sagemaker/.venv/
+__pycache__/
+*.py[cod]
+/.pnp
+.pnp.*
+.yarn/*
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/versions
+
+# testing
+/coverage
+/tmp/
+.pytest_cache/
+*.egg-info/
+
+# next.js
+/.next/
+/out/
+
+# production
+/build
+/.artifacts
+
+# misc
+.DS_Store
+*.pem
+.claude/
+.vscode/
+
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+.pnpm-debug.log*
+
+# env files (can opt-in for committing if needed)
+.env*
+!infrastructure/document-worker/.env.example
+
+# vercel
+.vercel
+
+# typescript
+*.tsbuildinfo
+next-env.d.ts
+
+# generated OpenAPI/SDK artifacts
+docs/openapi.generated.json
+lib/sdk/generated/openapi.d.ts
+packages/js-sdk/dist/
+packages/cli/dist/
+
+# Large taxonomy data files
+taxonomy/
+libs/eval/runs
+
+# Sentry Config File
+.env.sentry-build-plugin
+
+# Next build output (app workspace)
+apps/omni/.next/
+**/.next/
+
+# Shopify extension build output and local CLI state
+/extensions/*/dist/
+/.shopify/

omnicommerce-0.1.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) OmniCommerce
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

omnicommerce-0.1.1/PKG-INFO

@@ -0,0 +1,116 @@
+Metadata-Version: 2.5
+Name: omnicommerce
+Version: 0.1.1
+Summary: Python SDK for the OmniCommerce API. Generated from the public OpenAPI spec.
+Project-URL: Homepage, https://docs.omnicommerce.sg/sdk/python
+Project-URL: Repository, https://github.com/rmdort/omnicommerce
+License: MIT
+License-File: LICENSE
+Keywords: api,omni,omnicommerce,sdk
+Requires-Python: >=3.10
+Requires-Dist: httpx>=0.27
+Description-Content-Type: text/markdown
+
+# omnicommerce
+
+Python client for the [OmniCommerce API](https://docs.omnicommerce.sg/api-reference).
+
+The client is generated from the public OpenAPI spec, the same operation map as `@omni-commerce/sdk`. Sync and async clients take snake_case keyword arguments. Responses are parsed JSON.
+
+## Install
+
+Install from PyPI:
+
+```bash
+python3 -m pip install omnicommerce
+```
+
+Python 3.10+.
+
+## Usage
+
+```python
+import os
+from omnicommerce import Omni
+
+with Omni(api_key=os.environ["OMNI_API_KEY"]) as client:
+    products = client.products.list(q="lamp")
+    job = client.products.create(
+        product={
+            "sku": "SKU-100",
+            "title": "Sample product",
+            "price": 29.9,
+            "currency": "SGD",
+            "images": ["https://cdn.example.com/product.jpg"],
+        }
+    )
+    created = client.jobs.wait(job_id=job["jobId"])
+```
+
+API keys are organization-scoped. Do not send `organization_id` on API-key requests.
+
+```python
+from omnicommerce import AsyncOmni, Omni, OmniEnvironment
+
+client = Omni(
+    api_key="omni_sk_...",
+    environment=OmniEnvironment.LOCAL,  # http://localhost:3000
+    timeout_in_seconds=60,
+    max_retries=2,
+)
+
+async with AsyncOmni(api_key=os.environ["OMNI_API_KEY"]) as client:
+    products = await client.products.list(q="lamp")
+```
+
+`client.with_raw_response.products.get(product_id="prod_123")` returns `data`, `status_code`, `headers`, and `url`.
+
+## Resources
+
+| Client                         | Examples                                                                        |
+| ------------------------------ | ------------------------------------------------------------------------------- |
+| `client.products`              | `list`, `create`, `get`, `update`, `delete`, `publish`, `bulk_import`, `enrich` |
+| `client.orders`                | `list`, `create`, `get`, `update`                                               |
+| `client.promotions`            | `list`, `create`, `get`, `update`, `delete`, `sync`                             |
+| `client.price_books`           | `list`, `create`, `get`, `update`, `delete`, `preview`                          |
+| `client.aop`                   | `create`, `execute`, `get_config`, `update_config`, `retry`                     |
+| `client.jobs`                  | `get`, `cancel`, `wait`                                                         |
+| `client.webhooks`              | `list`, `create`                                                                |
+| `client.checkout_sessions`     | `create`, `get`, `update`, `complete`, `cancel`                                 |
+| `client.ucp.checkout_sessions` | Universal Commerce Protocol checkout                                            |
+| `client.oauth`                 | `token`, `revoke`                                                               |
+
+Every other documented tag is exposed the same way.
+
+## Errors
+
+```python
+from omnicommerce import NotFoundError, Omni, OmniError
+
+try:
+    client.products.get(product_id="missing")
+except NotFoundError:
+    pass
+except OmniError as error:
+    print(error.status_code, error.body)
+```
+
+## Webhooks
+
+```python
+from omnicommerce import construct_event
+
+event = construct_event(raw_body, headers, os.environ["OMNI_WEBHOOK_SECRET"])
+```
+
+Signature: HMAC-SHA256 over `{timestamp}.{raw_body}` compared to `X-Omni-Signature`.
+
+## Regenerate from OpenAPI
+
+From the monorepo root:
+
+```bash
+yarn sdk:generate
+```
+
+That refreshes `src/omnicommerce/_generated/resources.py` from `docs/openapi.json`.

omnicommerce-0.1.1/README.md

@@ -0,0 +1,103 @@
+# omnicommerce
+
+Python client for the [OmniCommerce API](https://docs.omnicommerce.sg/api-reference).
+
+The client is generated from the public OpenAPI spec, the same operation map as `@omni-commerce/sdk`. Sync and async clients take snake_case keyword arguments. Responses are parsed JSON.
+
+## Install
+
+Install from PyPI:
+
+```bash
+python3 -m pip install omnicommerce
+```
+
+Python 3.10+.
+
+## Usage
+
+```python
+import os
+from omnicommerce import Omni
+
+with Omni(api_key=os.environ["OMNI_API_KEY"]) as client:
+    products = client.products.list(q="lamp")
+    job = client.products.create(
+        product={
+            "sku": "SKU-100",
+            "title": "Sample product",
+            "price": 29.9,
+            "currency": "SGD",
+            "images": ["https://cdn.example.com/product.jpg"],
+        }
+    )
+    created = client.jobs.wait(job_id=job["jobId"])
+```
+
+API keys are organization-scoped. Do not send `organization_id` on API-key requests.
+
+```python
+from omnicommerce import AsyncOmni, Omni, OmniEnvironment
+
+client = Omni(
+    api_key="omni_sk_...",
+    environment=OmniEnvironment.LOCAL,  # http://localhost:3000
+    timeout_in_seconds=60,
+    max_retries=2,
+)
+
+async with AsyncOmni(api_key=os.environ["OMNI_API_KEY"]) as client:
+    products = await client.products.list(q="lamp")
+```
+
+`client.with_raw_response.products.get(product_id="prod_123")` returns `data`, `status_code`, `headers`, and `url`.
+
+## Resources
+
+| Client                         | Examples                                                                        |
+| ------------------------------ | ------------------------------------------------------------------------------- |
+| `client.products`              | `list`, `create`, `get`, `update`, `delete`, `publish`, `bulk_import`, `enrich` |
+| `client.orders`                | `list`, `create`, `get`, `update`                                               |
+| `client.promotions`            | `list`, `create`, `get`, `update`, `delete`, `sync`                             |
+| `client.price_books`           | `list`, `create`, `get`, `update`, `delete`, `preview`                          |
+| `client.aop`                   | `create`, `execute`, `get_config`, `update_config`, `retry`                     |
+| `client.jobs`                  | `get`, `cancel`, `wait`                                                         |
+| `client.webhooks`              | `list`, `create`                                                                |
+| `client.checkout_sessions`     | `create`, `get`, `update`, `complete`, `cancel`                                 |
+| `client.ucp.checkout_sessions` | Universal Commerce Protocol checkout                                            |
+| `client.oauth`                 | `token`, `revoke`                                                               |
+
+Every other documented tag is exposed the same way.
+
+## Errors
+
+```python
+from omnicommerce import NotFoundError, Omni, OmniError
+
+try:
+    client.products.get(product_id="missing")
+except NotFoundError:
+    pass
+except OmniError as error:
+    print(error.status_code, error.body)
+```
+
+## Webhooks
+
+```python
+from omnicommerce import construct_event
+
+event = construct_event(raw_body, headers, os.environ["OMNI_WEBHOOK_SECRET"])
+```
+
+Signature: HMAC-SHA256 over `{timestamp}.{raw_body}` compared to `X-Omni-Signature`.
+
+## Regenerate from OpenAPI
+
+From the monorepo root:
+
+```bash
+yarn sdk:generate
+```
+
+That refreshes `src/omnicommerce/_generated/resources.py` from `docs/openapi.json`.

omnicommerce-0.1.1/pyproject.toml

@@ -0,0 +1,24 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "omnicommerce"
+version = "0.1.1"
+description = "Python SDK for the OmniCommerce API. Generated from the public OpenAPI spec."
+readme = "README.md"
+requires-python = ">=3.10"
+license = { text = "MIT" }
+dependencies = ["httpx>=0.27"]
+keywords = ["omnicommerce", "omni", "api", "sdk"]
+
+[project.urls]
+Homepage = "https://docs.omnicommerce.sg/sdk/python"
+Repository = "https://github.com/rmdort/omnicommerce"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/omnicommerce"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+pythonpath = ["src"]