idi-manageorders-sdk 0.1.0__py3-none-any.whl

idi_manageorders_sdk-0.1.0.dist-info/METADATA

@@ -0,0 +1,29 @@
+Metadata-Version: 2.3
+Name: idi-manageorders-sdk
+Version: 0.1.0
+Summary: ShopWorks ManageOrders API SDK
+Project-URL: repository, https://github.com/impressdesigns/manageorders-sdk/
+Project-URL: documentation, https://impressdesigns.dev/manageorders-sdk/
+Author-email: Bradley Reynolds <bradley.reynolds@impressdesigns.com>
+License: MIT
+Requires-Python: >=3.10
+Requires-Dist: httpx>=0.27.2
+Requires-Dist: pydantic>=2.9.2
+Provides-Extra: dev
+Requires-Dist: mypy>=1.10.1; extra == 'dev'
+Requires-Dist: nox>=2024.4.15; extra == 'dev'
+Requires-Dist: pre-commit>=3.7.1; extra == 'dev'
+Requires-Dist: ruff>=0.5.2; extra == 'dev'
+Provides-Extra: docs
+Requires-Dist: furo>=2024.5.6; extra == 'docs'
+Requires-Dist: releases>=2.1.1; extra == 'docs'
+Requires-Dist: sphinx-autoapi>=3.1.2; extra == 'docs'
+Requires-Dist: sphinx>=7.4.4; extra == 'docs'
+Provides-Extra: tests
+Requires-Dist: coverage>=7.6.1; extra == 'tests'
+Requires-Dist: pytest-randomly>=3.15.0; extra == 'tests'
+Requires-Dist: pytest>=8.2.2; extra == 'tests'
+Description-Content-Type: text/markdown
+
+# manageorders-api
+ShopWorks ManageOrders API SDK

idi_manageorders_sdk-0.1.0.dist-info/RECORD

@@ -0,0 +1,7 @@
+manageorders_sdk/__init__.py,sha256=5G4EMub-py1c_ZkvluDFHRMd4ZQouTmY6GnYIhUgpXc,112
+manageorders_sdk/client.py,sha256=pjgmZCWx9W_MUVB8Oe6FCfT1-AFsgU6d0PV99mQbc2A,2048
+manageorders_sdk/models.py,sha256=PwDTA9iRNqscI1NoFr7m9fxQkInGPvqFfFDyLJGKZX4,2334
+idi_manageorders_sdk-0.1.0.dist-info/METADATA,sha256=7nuYsNB3fbh4H15C3_6dtgOMUwhM_UolUwt45fWjO3g,1104
+idi_manageorders_sdk-0.1.0.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
+idi_manageorders_sdk-0.1.0.dist-info/licenses/LICENSE,sha256=1zNUC2AzIRNS7IofenZpZXrr3jt93nq3Bc10iocHjRo,1072
+idi_manageorders_sdk-0.1.0.dist-info/RECORD,,

idi_manageorders_sdk-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.26.3
+Root-Is-Purelib: true
+Tag: py3-none-any

idi_manageorders_sdk-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Impress Designs
+
+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.

manageorders_sdk/__init__.py

@@ -0,0 +1,5 @@
+"""ShopWorks ManageOrders API SDK."""
+
+from .client import ManageOrdersClient
+
+__all__ = ["ManageOrdersClient"]

manageorders_sdk/client.py

@@ -0,0 +1,73 @@
+"""Interacting with ManageOrders API."""
+
+from datetime import UTC, datetime, timedelta
+from typing import Any, Self
+
+import httpx
+from httpx import Response
+
+from .models import Order
+
+
+class ManageOrdersClient:
+    """A class wrapping interaction with ManageOrders API."""
+
+    def __init__(
+        self,
+        username: str,
+        password: str,
+    ) -> None:
+        """Initialize the ManageOrdersClient class."""
+        self.base_url = "https://manageordersapi.com"
+        self.username = username
+        self.password = password
+        self.token = ""
+        self.token_expires_at = datetime.now(tz=UTC)
+
+    def _update_token(self: Self) -> None:
+        """Update the OAUTH token."""
+        if self.token_expires_at > datetime.now(tz=UTC):
+            return
+
+        auth_dict = {
+            "username": self.username,
+            "password": self.password,
+        }
+        response = httpx.post(f"{self.base_url}/v1/manageorders/signin", json=auth_dict)
+        response.raise_for_status()
+        data = response.json()
+        self.token = data["access_token"]
+        self.token_expires_at = datetime.now(tz=UTC) + timedelta(hours=1)
+
+    def _make_request(
+        self,
+        method: str,
+        path: str,
+        params: dict[str, Any] | None = None,
+        json: dict[str, Any] | None = None,
+    ) -> Response:
+        """Make a request to Core."""
+        self._update_token()
+
+        headers = {"Authorization": "Bearer " + self.token}
+
+        args = {
+            "url": self.base_url + path,
+            "method": method,
+            "headers": headers,
+        }
+
+        if params is not None:
+            args["params"] = params
+
+        if json is not None:
+            args["json"] = json
+
+        return httpx.request(**args)  # type: ignore[arg-type]
+
+    def upload_order(
+        self,
+        order: Order,
+    ) -> Response:
+        """Upload an order to ManageOrders."""
+        return self._make_request("POST", "/onsite/order-push", json=order.model_dump(by_alias=True, exclude_none=True))

manageorders_sdk/models.py

@@ -0,0 +1,65 @@
+"""Models."""
+
+from typing import Literal
+
+from pydantic import BaseModel, Field
+
+DATE_REGEX = "[0-9]{2}/[0-9]{2}/[0-9]{4}|[0-9]{2}"
+
+
+class Design(BaseModel):
+    """Design."""
+
+    design_number: int = Field(serialization_alias="id_Design")
+    design_type: int = Field(serialization_alias="id_DesignType")
+
+
+class LineItem(BaseModel):
+    """LineItem."""
+
+    part_number: str = Field(serialization_alias="PartNumber")
+    product_class: int = Field(serialization_alias="id_ProductClass")
+    quantity: int = Field(serialization_alias="Qty")
+
+    external_shipment_id: str = Field(serialization_alias="ExtShipID")
+
+
+class Address(BaseModel):
+    """Address."""
+
+    external_shipment_id: str | None = Field(None, serialization_alias="ExtShipID")
+
+    shipping_method: str | None = Field(None, serialization_alias="ShipMethod")
+
+    company: str | None = Field(None, serialization_alias="ShipCompany")
+    address1: str | None = Field(None, serialization_alias="ShipAddress01")
+    address2: str | None = Field(None, serialization_alias="ShipAddress02")
+    city: str | None = Field(None, serialization_alias="ShipCity")
+    state: str | None = Field(None, serialization_alias="ShipState")
+    postal_code: str | None = Field(None, serialization_alias="ShipZip")
+    country: str | None = Field(None, serialization_alias="ShipCountry")
+
+
+class Note(BaseModel):
+    """Note."""
+
+    note: str
+    type_: Literal["Notes To Production", "Notes To Shipping"] = Field(serialization_alias="Type")
+
+
+class Order(BaseModel):
+    """Order."""
+
+    external_order_id: str = Field(serialization_alias="ExtOrderID")
+    external_source: str = Field(serialization_alias="ExtSource")
+
+    order_type: int = Field(serialization_alias="id_OrderType")
+    employee_created_by: int = Field(serialization_alias="id_EmpCreatedBy")
+    customer_id: int = Field(serialization_alias="id_Customer")
+    customer_purchase_order: str = Field(serialization_alias="CustomerPurchaseOrder")
+    ship_date: str = Field(pattern=DATE_REGEX, serialization_alias="date_OrderRequestedToShip")
+
+    designs: list[Design] = Field(serialization_alias="Designs")
+    line_items: list[LineItem] = Field(serialization_alias="LineItems")
+    addresses: list[Address] = Field(serialization_alias="ShippingAddresses")
+    notes: list[Note] = Field(serialization_alias="Notes")