idi-manageorders-sdk 0.5.0__tar.gz → 0.7.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (28) hide show
  1. idi_manageorders_sdk-0.7.0/.devcontainer/devcontainer-lock.json +9 -0
  2. {idi_manageorders_sdk-0.5.0 → idi_manageorders_sdk-0.7.0}/.devcontainer/devcontainer.json +1 -1
  3. {idi_manageorders_sdk-0.5.0 → idi_manageorders_sdk-0.7.0}/.github/dependabot.yaml +1 -1
  4. {idi_manageorders_sdk-0.5.0 → idi_manageorders_sdk-0.7.0}/.github/workflows/dependency-review.yaml +1 -1
  5. {idi_manageorders_sdk-0.5.0 → idi_manageorders_sdk-0.7.0}/.github/workflows/python-ci.yaml +3 -3
  6. {idi_manageorders_sdk-0.5.0 → idi_manageorders_sdk-0.7.0}/.github/workflows/python-publish-pypi.yaml +4 -6
  7. {idi_manageorders_sdk-0.5.0 → idi_manageorders_sdk-0.7.0}/.pre-commit-config.yaml +1 -14
  8. {idi_manageorders_sdk-0.5.0 → idi_manageorders_sdk-0.7.0}/PKG-INFO +3 -2
  9. {idi_manageorders_sdk-0.5.0 → idi_manageorders_sdk-0.7.0}/docs/source/changelog.rst +8 -0
  10. {idi_manageorders_sdk-0.5.0 → idi_manageorders_sdk-0.7.0}/pyproject.toml +2 -2
  11. {idi_manageorders_sdk-0.5.0 → idi_manageorders_sdk-0.7.0}/src/manageorders_sdk/client.py +9 -2
  12. {idi_manageorders_sdk-0.5.0 → idi_manageorders_sdk-0.7.0}/src/manageorders_sdk/models.py +40 -5
  13. idi_manageorders_sdk-0.7.0/uv.lock +1151 -0
  14. idi_manageorders_sdk-0.5.0/.devcontainer/devcontainer-lock.json +0 -9
  15. idi_manageorders_sdk-0.5.0/requirements-dev.txt +0 -470
  16. idi_manageorders_sdk-0.5.0/requirements.txt +0 -93
  17. idi_manageorders_sdk-0.5.0/uv.lock +0 -1002
  18. {idi_manageorders_sdk-0.5.0 → idi_manageorders_sdk-0.7.0}/.gitignore +0 -0
  19. {idi_manageorders_sdk-0.5.0 → idi_manageorders_sdk-0.7.0}/LICENSE +0 -0
  20. {idi_manageorders_sdk-0.5.0 → idi_manageorders_sdk-0.7.0}/README.md +0 -0
  21. {idi_manageorders_sdk-0.5.0 → idi_manageorders_sdk-0.7.0}/docs/Makefile +0 -0
  22. {idi_manageorders_sdk-0.5.0 → idi_manageorders_sdk-0.7.0}/docs/source/conf.py +0 -0
  23. {idi_manageorders_sdk-0.5.0 → idi_manageorders_sdk-0.7.0}/docs/source/index.rst +0 -0
  24. {idi_manageorders_sdk-0.5.0 → idi_manageorders_sdk-0.7.0}/noxfile.py +0 -0
  25. {idi_manageorders_sdk-0.5.0 → idi_manageorders_sdk-0.7.0}/src/manageorders_sdk/__init__.py +0 -0
  26. {idi_manageorders_sdk-0.5.0 → idi_manageorders_sdk-0.7.0}/src/manageorders_sdk/py.typed +0 -0
  27. {idi_manageorders_sdk-0.5.0 → idi_manageorders_sdk-0.7.0}/tests/__init__.py +0 -0
  28. {idi_manageorders_sdk-0.5.0 → idi_manageorders_sdk-0.7.0}/tests/test_client.py +0 -0
@@ -0,0 +1,9 @@
1
+ {
2
+ "features": {
3
+ "ghcr.io/devcontainers/features/python:1.7.1": {
4
+ "version": "1.7.1",
5
+ "resolved": "ghcr.io/devcontainers/features/python@sha256:cf9b6d879790a594b459845b207c5e1762a0c8f954bb8033ff396e497f9c301b",
6
+ "integrity": "sha256:cf9b6d879790a594b459845b207c5e1762a0c8f954bb8033ff396e497f9c301b"
7
+ }
8
+ }
9
+ }
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "image": "mcr.microsoft.com/devcontainers/universal:2",
3
3
  "features": {
4
- "ghcr.io/devcontainers/features/python:1.6.5": {
4
+ "ghcr.io/devcontainers/features/python:1.7.1": {
5
5
  "version": "3.12",
6
6
  "installTools": false
7
7
  }
@@ -14,7 +14,7 @@ updates:
14
14
  patterns:
15
15
  - "*"
16
16
 
17
- - package-ecosystem: pip
17
+ - package-ecosystem: uv
18
18
  directory: /
19
19
  schedule:
20
20
  interval: monthly
@@ -15,6 +15,6 @@ jobs:
15
15
  uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
16
16
 
17
17
  - name: "Dependency Review"
18
- uses: actions/dependency-review-action@4081bf99e2866ebe428fc0477b69eb4fcda7220a # v4.4.0
18
+ uses: actions/dependency-review-action@da24556b548a50705dd671f47852072ea4c105d9 # v4.7.1
19
19
  with:
20
20
  config-file: impressdesigns/.github/.github/dependency-review-config.yaml@main
@@ -15,7 +15,7 @@ jobs:
15
15
  uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
16
16
 
17
17
  - name: Setup Python
18
- uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5.3.0
18
+ uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0
19
19
  with:
20
20
  python-version: 3.12
21
21
  allow-prereleases: true
@@ -47,7 +47,7 @@ jobs:
47
47
  run: uv run coverage xml
48
48
 
49
49
  - name: Upload coverage reports to Codecov
50
- uses: codecov/codecov-action@5c47607acb93fed5485fdbf7232e8a31425f672a # v5.0.2
50
+ uses: codecov/codecov-action@18283e04ce6e62d37312384ff67231eb8fd56d24 # v5.4.3
51
51
  env:
52
52
  CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
53
53
 
@@ -57,4 +57,4 @@ jobs:
57
57
  pages: write
58
58
  id-token: write
59
59
 
60
- uses: darbiadev/.github/.github/workflows/github-pages-python-sphinx.yaml@41518576ed6c499ed3e68d5cbceaeaa50abd471a # v14.1.0
60
+ uses: darbiadev/.github/.github/workflows/github-pages-python-sphinx.yaml@91dda16028f109ac78016dd740206fd109740068 # v15.0.0
@@ -24,7 +24,7 @@ jobs:
24
24
  uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
25
25
 
26
26
  - name: Build and inspect Python 🐍 package 📦
27
- uses: hynek/build-and-inspect-python-package@f01e4d047aadcc0c054c95ec9900da3ec3fc7a0f # v2.10.0
27
+ uses: hynek/build-and-inspect-python-package@b5076c307dc91924a82ad150cdd1533b444d3310 # v2.12.0
28
28
  with:
29
29
  attest-build-provenance-github: ${{ github.event.action == 'published' }}
30
30
 
@@ -35,20 +35,18 @@ jobs:
35
35
  runs-on: ubuntu-latest
36
36
  environment:
37
37
  name: pypi
38
- url: https://pypi.org/project/crazylibs/${{ github.ref_name }}
38
+ url: https://pypi.org/project/idi-manageorders-sdk/${{ github.ref_name }}
39
39
  permissions:
40
40
  id-token: write
41
41
 
42
42
  steps:
43
43
  - name: Download dists
44
- uses: actions/download-artifact@fa0a91b85d4f404e444e00e005971372dc801d16 # v4.1.8
44
+ uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4.3.0
45
45
  with:
46
46
  name: Packages
47
47
  path: dist/
48
48
 
49
49
  - name: Publish distribution 📦 to PyPI
50
- uses: pypa/gh-action-pypi-publish@15c56dba361d8335944d31a2ecd17d700fc7bcbc # v1.12.2
50
+ uses: pypa/gh-action-pypi-publish@76f52bc884231f62b9a034ebfe128415bbaabdfc # v1.12.4
51
51
  with:
52
- attestations: true
53
- verbose: true
54
52
  print-hash: true
@@ -15,19 +15,6 @@ repos:
15
15
  exclude: .devcontainer/devcontainer-lock.json
16
16
 
17
17
  - repo: https://github.com/astral-sh/uv-pre-commit
18
- rev: 0.4.30
18
+ rev: 0.6.5
19
19
  hooks:
20
20
  - id: uv-lock
21
- - id: uv-export
22
- args:
23
- - --frozen
24
- - --no-emit-project
25
- - --output-file=requirements.txt
26
- files: pyproject.toml|uv.lock
27
- - id: uv-export
28
- args:
29
- - --frozen
30
- - --no-emit-project
31
- - --all-extras
32
- - --output-file=requirements-dev.txt
33
- files: pyproject.toml|uv.lock
@@ -1,11 +1,12 @@
1
- Metadata-Version: 2.3
1
+ Metadata-Version: 2.4
2
2
  Name: idi-manageorders-sdk
3
- Version: 0.5.0
3
+ Version: 0.7.0
4
4
  Summary: ShopWorks ManageOrders API SDK
5
5
  Project-URL: repository, https://github.com/impressdesigns/manageorders-sdk/
6
6
  Project-URL: documentation, https://impressdesigns.dev/manageorders-sdk/
7
7
  Author-email: Bradley Reynolds <bradley.reynolds@impressdesigns.com>
8
8
  License: MIT
9
+ License-File: LICENSE
9
10
  Requires-Python: >=3.10
10
11
  Requires-Dist: httpx>=0.27.2
11
12
  Requires-Dist: pydantic>=2.9.2
@@ -1,6 +1,14 @@
1
1
  Changelog
2
2
  =========
3
3
 
4
+ - :release:`0.7.0 <18th June 2025>`
5
+ - :feature:`-` Add support for uploading tracking data
6
+
7
+ - :release:`0.6.0 <9th December 2024>`
8
+ - :bug:`-` Use ``id_token`` instead of ``access_token`` for authentication
9
+ - :bug:`-` Add date validation to date fields in ``Order``
10
+ - :bug:`-` Change price field to be float in ``LinesOEItem``
11
+
4
12
  - :release:`0.5.0 <22nd November 2024>`
5
13
  - :feature:`-` Add ``API Source`` field to ``Order`` model
6
14
 
@@ -1,6 +1,6 @@
1
1
  [project]
2
2
  name = "idi-manageorders-sdk"
3
- version = "0.5.0"
3
+ version = "0.7.0"
4
4
  description = "ShopWorks ManageOrders API SDK"
5
5
  authors = [
6
6
  { name = "Bradley Reynolds", email = "bradley.reynolds@impressdesigns.com" },
@@ -60,7 +60,7 @@ ignore = [
60
60
  ]
61
61
 
62
62
  [tool.ruff.lint.isort]
63
- known-first-party = ["core"]
63
+ known-first-party = ["manageorders_sdk"]
64
64
 
65
65
  [tool.ruff.lint.pydocstyle]
66
66
  convention = "numpy"
@@ -6,7 +6,7 @@ from typing import Any, Self
6
6
  import httpx
7
7
  from httpx import Response
8
8
 
9
- from .models import Order
9
+ from .models import Order, TrackingContainer
10
10
 
11
11
 
12
12
  class ManageOrdersClient:
@@ -36,7 +36,7 @@ class ManageOrdersClient:
36
36
  response = httpx.post(f"{self.base_url}/v1/manageorders/signin", json=auth_dict)
37
37
  response.raise_for_status()
38
38
  data = response.json()
39
- self.token = data["access_token"]
39
+ self.token = data["id_token"]
40
40
  self.token_expires_at = datetime.now(tz=UTC) + timedelta(hours=1)
41
41
 
42
42
  def _make_request(
@@ -71,3 +71,10 @@ class ManageOrdersClient:
71
71
  ) -> Response:
72
72
  """Upload an order to ManageOrders."""
73
73
  return self._make_request("POST", "/onsite/order-push", json=order.model_dump(by_alias=True, exclude_none=True))
74
+
75
+ def upload_tracking(
76
+ self,
77
+ tracking_data: TrackingContainer,
78
+ ) -> Response:
79
+ """Upload tracking data to ManageOrders."""
80
+ return self._make_request("POST", "/onsite/track-push", json=tracking_data.model_dump(by_alias=True, exclude_none=True))
@@ -1,8 +1,9 @@
1
1
  """Models."""
2
2
 
3
+ from datetime import date
3
4
  from typing import Literal
4
5
 
5
- from pydantic import BaseModel, Field
6
+ from pydantic import BaseModel, Field, FieldSerializationInfo, field_serializer
6
7
 
7
8
  DATE_REGEX = "[0-9]{2}/[0-9]{2}/[0-9]{4}|[0-9]{2}"
8
9
 
@@ -98,7 +99,7 @@ class LinesOEItem(BaseModel):
98
99
  description: str | None = Field(None, serialization_alias="Description")
99
100
  size: str | None = Field(None, serialization_alias="Size")
100
101
  quantity: int | None = Field(None, serialization_alias="Qty")
101
- price: int | None = Field(None, serialization_alias="Price")
102
+ price: float | None = Field(None, serialization_alias="Price")
102
103
  product_class_id: int | None = Field(None, serialization_alias="id_ProductClass")
103
104
  custom_field_1: str | None = Field(None, serialization_alias="CustomField01")
104
105
  custom_field_2: str | None = Field(None, serialization_alias="CustomField02")
@@ -183,9 +184,9 @@ class Order(BaseModel):
183
184
  external_source: str = Field(serialization_alias="ExtSource")
184
185
  external_customer_id: str | None = Field(None, serialization_alias="ExtCustomerID")
185
186
  external_customer_pref: str | None = Field(None, serialization_alias="ExtCustomerPref")
186
- date_order_placed: str | None = Field(None, serialization_alias="date_OrderPlaced")
187
- date_order_requested_to_ship: str | None = Field(None, serialization_alias="date_OrderRequestedToShip")
188
- date_order_drop_dead: str | None = Field(None, serialization_alias="date_OrderDropDead")
187
+ date_order_placed: str | None = Field(None, pattern=DATE_REGEX, serialization_alias="date_OrderPlaced")
188
+ date_order_requested_to_ship: str | None = Field(None, pattern=DATE_REGEX, serialization_alias="date_OrderRequestedToShip")
189
+ date_order_drop_dead: str | None = Field(None, pattern=DATE_REGEX, serialization_alias="date_OrderDropDead")
189
190
  order_type_id: int | None = Field(None, serialization_alias="id_OrderType")
190
191
  sales_status_id: int | None = Field(None, serialization_alias="id_SalesStatus")
191
192
  employee_created_by: int | None = Field(None, serialization_alias="id_EmpCreatedBy")
@@ -210,3 +211,37 @@ class Order(BaseModel):
210
211
  payments: list[Payment] | None = Field(None, serialization_alias="Payments")
211
212
  addresses: list[ShippingAddress] | None = Field(None, serialization_alias="ShippingAddresses")
212
213
  attachments: list[Attachment] | None = Field(None, serialization_alias="Attachments")
214
+
215
+
216
+ class Tracking(BaseModel):
217
+ """Tracking model."""
218
+
219
+ tracking: str = Field(serialization_alias="Tracking")
220
+
221
+ date_shipped: date = Field(serialization_alias="date_Shipped")
222
+
223
+ company: str = Field(serialization_alias="AddressCompany")
224
+ name: str = Field(serialization_alias="Name")
225
+
226
+ address1: str = Field(serialization_alias="Address01")
227
+ address2: str = Field(serialization_alias="Address02")
228
+ city: str = Field(serialization_alias="AddressCity")
229
+ state: str = Field(serialization_alias="AddressState")
230
+ postal_code: str = Field(serialization_alias="AddressZip")
231
+ country: str = Field(serialization_alias="AddressCountry")
232
+
233
+ cost: float = Field(serialization_alias="Cost")
234
+ weight: float = Field(serialization_alias="Weight")
235
+
236
+ @field_serializer("date_shipped")
237
+ def serialize_date_shipped(self, date_: date, _info: FieldSerializationInfo) -> str:
238
+ """Serialize date_shipped to string."""
239
+ return date_.strftime(r"%m/%d/%Y")
240
+
241
+
242
+ class TrackingContainer(BaseModel):
243
+ """TrackingContainer model."""
244
+
245
+ api_source: str | None = Field(serialization_alias="APISource")
246
+ external_order_id: str = Field(serialization_alias="ExtOrderID")
247
+ tracking: Tracking = Field(serialization_alias="Tracking")