spyreapi 0.0.1__py3-none-any.whl

spyre/utils.py

@@ -0,0 +1,130 @@
+from Models.sales_models import *
+from typing import TypeVar, Optional, Type, List, Set
+from copy import deepcopy
+from pydantic import BaseModel
+
+T = TypeVar('T', bound=BaseModel)
+
+# These will always be excluded unless explicitly overridden
+DEFAULT_EXCLUDE_FIELDS = {'id', 'linkTable', 'linkType', 'linkNo', 'contact_type'}
+
+# Normalize paths by replacing numeric list indices with '*'
+def normalize_path(path: str) -> str:
+    return '.'.join('*' if part.isdigit() else part for part in path.split('.'))
+
+# Should exclude based on normalized paths
+def should_exclude(field_path: str, exclude_paths: Set[str]) -> bool:
+    return field_path in exclude_paths or field_path.split('.')[-1] in exclude_paths
+
+def create_duplicate_record(
+    instance: T,
+    exclude_fields: Optional[List[str]] = None,
+    _prefix: str = ""
+) -> T:
+    if exclude_fields is None:
+        exclude_fields = []
+
+    # Normalize exclude paths so comparisons are wildcard-friendly
+    full_exclude_paths = {normalize_path(f) for f in DEFAULT_EXCLUDE_FIELDS.union(set(exclude_fields))}
+    cleaned_data = {}
+
+    for field_name, value in instance.model_dump().items():
+        full_path = f"{_prefix}.{field_name}" if _prefix else field_name
+
+        if should_exclude(full_path, full_exclude_paths):
+            continue
+
+        if isinstance(value, BaseModel):
+            cleaned_data[field_name] = create_duplicate_record(value, exclude_fields, _prefix=full_path)
+
+        elif isinstance(value, list):
+            cleaned_items = []
+            for i, item in enumerate(value):
+                if isinstance(item, BaseModel):
+                    cleaned_items.append(create_duplicate_record(item, exclude_fields, _prefix=full_path))
+                elif isinstance(item, dict):
+                    cleaned_dict = {}
+                    for k, v in item.items():
+                        field_k_path = f"{full_path}.{k}"
+                        if isinstance(v, BaseModel):
+                            cleaned_dict[k] = create_duplicate_record(v, exclude_fields, _prefix=field_k_path)
+                        elif should_exclude(field_k_path, full_exclude_paths):
+                            continue
+                        else:
+                            cleaned_dict[k] = deepcopy(v)
+                    cleaned_items.append(cleaned_dict)
+                else:
+                    cleaned_items.append(deepcopy(item))
+            cleaned_data[field_name] = cleaned_items
+
+        elif isinstance(value, dict):
+            cleaned_dict = {}
+            for k, v in value.items():
+                dict_path = f"{full_path}.{k}"
+                if isinstance(v, BaseModel):
+                    cleaned_dict[k] = create_duplicate_record(v, exclude_fields, _prefix=dict_path)
+                elif should_exclude(dict_path, full_exclude_paths):
+                    continue
+                else:
+                    cleaned_dict[k] = deepcopy(v)
+            cleaned_data[field_name] = cleaned_dict
+
+        else:
+            cleaned_data[field_name] = deepcopy(value)
+
+    return instance.__class__(**cleaned_data)
+
+def create_sales_order_from_invoice(invoice: Invoice) -> SalesOrder:
+    """Creates a Sales Order from an Invoice
+    
+    
+    Changes when converting
+    freight negative
+    backorders
+    extendedpriceorderd
+    orderqty
+    shippingCarrier
+    subtotalordered
+    taxes : {total}
+    total
+    totalOrdered
+    trackingNo
+
+    """
+
+
+    return SalesOrder(
+        orderNo=invoice.orderNo,
+        division=invoice.division,
+        location=invoice.location,
+        profitCenter=invoice.profitCenter,
+        customer=deepcopy(invoice.customer),
+        currency=deepcopy(invoice.currency),
+        status="O",
+        type="O",
+        hold=False,
+        orderDate=invoice.orderDate,
+        address=create_duplicate_record(invoice.address, exclude_fields=["contacts.contact_type"]),
+        shippingAddress=create_duplicate_record(invoice.shippingAddress),
+        customerPO=invoice.customerPO,
+        fob=invoice.fob,
+        incoterms=invoice.incoterms,
+        incotermsPlace=invoice.incotermsPlace,
+        referenceNo=None,
+        shippingCarrier=None,
+        shipDate=invoice.shipDate,
+        trackingNo=None,
+        termsCode=invoice.termsCode,
+        termsText=invoice.termsText,
+        freight=f"-{invoice.freight}",
+        subtotal=invoice.subtotal,
+        total=invoice.total,
+        items = [
+            create_duplicate_record(item).model_copy(update={
+                "orderQty": f"-{item.orderQty}" if item.orderQty != "0" else item.orderQty ,
+                "committedQty": f"-{item.committedQty}" if item.committedQty != "0" else item.committedQty
+            })
+            for item in invoice.items or []
+        ],
+        udf=deepcopy(invoice.udf),
+    )

spyreapi-0.0.1.dist-info/METADATA

@@ -0,0 +1,37 @@
+Metadata-Version: 2.4
+Name: spyreapi
+Version: 0.0.1
+Summary: A robust and extensible Python client for interacting with the [Spire Business Software API](https://developer.spiresystems.com/reference). This client provides an object-oriented interface to get, create, update, delete, query, filter, sort, and manage various Spire modules such as Sales Orders, Invoices, Inventory Items, and more.
+Author-email: Sanjid Sharaf <sanjidsharaf1@gmail.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/sanjid-sharaf/spyre/
+Project-URL: Issues, https://github.com/sanjid-sharaf/spyre/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# Spire API Python Client
+
+A robust and extensible Python client for interacting with the [Spire Business Software API](https://developer.spiresystems.com/reference). This client provides an object-oriented interface to get, create, update, delete, query, filter, sort, and manage various Spire modules such as Sales Orders, Invoices, Inventory Items, and more.
+
+---
+
+## ✨ Features
+
+- ✅ Object-oriented resource wrappers for each module (e.g., `salesOrder`, `invoice`, `item`)
+- 🔍 Full-text search via `q` parameter
+- 🔁 Pagination with `start` and `limit` support
+- 🧾 JSON-based advanced filtering (supports `$gt`, `$lt`, `$in`, `$or`, etc.)
+- ↕️ Multi-field sorting with ascending/descending control
+- 🔧 Clean abstraction layer for API endpoints
+- 📦 Powered by `pydantic` models for validation
+
+---
+
+## 📦 Installation
+
+```bash
+pip install -r requirements.txt

spyreapi-0.0.1.dist-info/RECORD

@@ -0,0 +1,19 @@
+spyre/Exceptions.py,sha256=Ikl-eEG_z2YsGbNZt04fw3i1dY_sAMg2VK7cReMEYo4,1511
+spyre/__init__.py,sha256=XmA9jt7wrNJaTNHNHBGg9wM7JL3mO0nYYPYzCHCZOEw,583
+spyre/client.py,sha256=EX-WVJJ60mgo6SzT5HZ9b73kG2hNP3lMYuJoEx7kmac,7485
+spyre/config.py,sha256=rQZza2Rg09cnwIDbdSKkbuCiZkh-vjiy4XHho2QDJ-k,96
+spyre/customers.py,sha256=CafIyuCszTDF4bybLyR4NC6o5AUbvabFZBhwxX8CNg0,5899
+spyre/inventory.py,sha256=QC7C6OGrxejfzm0vOhm1flj3go8DJrkny1lBM_UjbaA,12477
+spyre/sales.py,sha256=NbCh-yQn720PI6QKW6kS60UnCgcpxJ3YA2bZEpTb-fY,12079
+spyre/spire.py,sha256=o7tBVdFVmitCVAQdZypAIvvVnn0Q2Sy9vjvCXcEnsms,483
+spyre/utils.py,sha256=R3JDlDtP_8u6nxtueEp8csTeRxT_2O-rLOPQvW3qgbE,4921
+spyre/Models/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+spyre/Models/customers_models.py,sha256=GC-LRBjUGlixpl3tLzWf5_xEaoF95g6NT_tD6Kv4X08,1552
+spyre/Models/inventory_models.py,sha256=U6MDWRl9rSBZNTkcedgdaz7aYsdV5Nlx2155r012_CE,5685
+spyre/Models/sales_models.py,sha256=4CKcB3bZvTLpKJ48LjevnlYCWPzLyhD6_NR2c4WZeHc,6284
+spyre/Models/shared_models.py,sha256=okQbbq6ReFQDDU1OyEeJ4B-gu423bVtmN6ZxhA58cVc,3146
+spyreapi-0.0.1.dist-info/licenses/LICENSE,sha256=9yQHgnVrnoOl6Dnszcua8RuDohRsP9iyNJRVHISK6n0,1084
+spyreapi-0.0.1.dist-info/METADATA,sha256=09JSnxSASzT5Vj6zAmU3jmbqQutT_09bWC4geQ5rJzY,1730
+spyreapi-0.0.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+spyreapi-0.0.1.dist-info/top_level.txt,sha256=GsXUFItM5Ozy2wtCqd9eIumaXq1MUY0DsyVWuvGyQH4,6
+spyreapi-0.0.1.dist-info/RECORD,,

spyreapi-0.0.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

spyreapi-0.0.1.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) [2025] [2025]
+
+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.

spyreapi-0.0.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+spyre