spyreapi 0.0.2__tar.gz → 0.0.3__tar.gz

spyreapi-0.0.3/MANIFEST.in

@@ -0,0 +1,4 @@
+include README.md
+include LICENSE
+global-exclude *.pyc
+global-exclude tests/*

{spyreapi-0.0.2/src/spyreapi.egg-info → spyreapi-0.0.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: spyreapi
-Version: 0.0.2
+Version: 0.0.3
 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
@@ -42,3 +42,20 @@ A robust and extensible Python client for interacting with the [Spire Business S
 
 ```bash
 pip install -r requirements.txt
+```
+
+---
+
+## ⚙️ Configuration
+
+- Before using the client, set up your environment configuration:
+
+### Add your Base URL to your spire server to a `.env` file
+
+- In your project root, create a `.env` file to securely store your Spire configuration.
+- Add the following variable:
+
+```env
+BASE_URL = https://{your-spire-domain}/api/v2/companies/
+```
+- Replace {your-spire-domain} with your actual Spire server's hostname or IP address.

{spyreapi-0.0.2 → spyreapi-0.0.3}/README.md

@@ -20,3 +20,20 @@ A robust and extensible Python client for interacting with the [Spire Business S
 
 ```bash
 pip install -r requirements.txt
+```
+
+---
+
+## ⚙️ Configuration
+
+- Before using the client, set up your environment configuration:
+
+### Add your Base URL to your spire server to a `.env` file
+
+- In your project root, create a `.env` file to securely store your Spire configuration.
+- Add the following variable:
+
+```env
+BASE_URL = https://{your-spire-domain}/api/v2/companies/
+```
+- Replace {your-spire-domain} with your actual Spire server's hostname or IP address.

{spyreapi-0.0.2 → spyreapi-0.0.3}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "spyreapi"
-version = "0.0.2"
+version = "0.0.3"
 authors = [
   { name="Sanjid Sharaf", email="sanjidsharaf1@gmail.com" },
 ]

{spyreapi-0.0.2 → spyreapi-0.0.3}/src/spyre/Models/sales_models.py

@@ -15,7 +15,7 @@ class SalesOrderItem(BaseModel):
     sequence: Optional[int] = None
     parentSequence: Optional[int] = None
     inventory: Optional[Inventory] = None
-    serials: Optional[str] = None
+    serials: Optional[List[str]] = None
     whse: Optional[str] = None
     partNo: Optional[str] = None
     description: Optional[str] = None

{spyreapi-0.0.2 → spyreapi-0.0.3}/src/spyre/Models/shared_models.py

@@ -1,4 +1,4 @@
-from typing import List, Optional, Dict, Union
+from typing import List, Optional, Dict, Union, Any
 from pydantic import BaseModel, model_validator
 
 class PhoneFax(BaseModel):
@@ -94,3 +94,32 @@ class Address(BaseModel):
             if isinstance(contacts, list) and len(contacts) > 3:
                 data['contacts'] = contacts[:3]
         return data
+
+class AssignedTo(BaseModel):
+    id: Optional[int] = None
+    uuid: Optional[str] = None
+    username: Optional[str] = None
+    
+class Note(BaseModel):
+    id: Optional[int] = None
+    linkTable: Optional[str] = None
+    linkNo: Optional[str] = None
+    subject: Optional[str] = None
+    body: Optional[str] = None
+    attachment: Optional[Any] = None
+    attachmentName: Optional[str] = None
+    dueDate: Optional[str] = None
+    completedDate: Optional[str] = None
+    attention: Optional[str] = None
+    type: Optional[str] = None
+    displayType: Optional[str] = None
+    assignedTo: Optional[AssignedTo] = None
+    groupType: Optional[str] = None
+    qty: Optional[int] = None
+    alert: Optional[Union[str, bool]] = None
+    print: Optional[Union[str, bool]] = None
+    created: Optional[str] = None
+    createdBy: Optional[str] = None
+    modified: Optional[str] = None
+    modifiedBy: Optional[str] = None
+    links: Optional[Dict[str, str]] = None

{spyreapi-0.0.2 → spyreapi-0.0.3}/src/spyre/client.py

@@ -116,8 +116,13 @@ class SpireClient():
 
             if query:
                 params.append(("q", query))
-
+                
             if filter:
+                model_fields = resource_cls.Model.model_fields.keys()
+                invalid_fields = [key for key in filter.keys() if key not in model_fields]
+                if invalid_fields:
+                    raise ValueError(f"Invalid filter field(s): {invalid_fields}. for {resource_cls.Model.__name__} ")
+
                 encoded_filter = json.dumps(filter)
                 params.append(("filter", encoded_filter))
 

spyreapi-0.0.3/src/spyre/crm.py

@@ -0,0 +1,26 @@
+from .client import APIResource, SpireClient
+from .Models.shared_models import Note
+
+class CRMClient():
+    
+    def __init__(self, client: SpireClient):
+        self.client = client
+        self.endpoint = "crm"
+
+    def get_note(self, id : int) -> "note":
+        """
+        Retrieve a note by its ID.
+
+        Args:
+            id (int): The ID of the note to retrieve.
+
+        Returns:
+            note: The retrieved note
+        """
+        response = self.client._get(f"/{self.endpoint}/notes/{str(id)}")
+        return note.from_json(response, self.client)
+
+
+class note(APIResource[Note]):
+    endpoint = 'crm/notes'
+    Model = Note

{spyreapi-0.0.2 → spyreapi-0.0.3}/src/spyre/customers.py

@@ -83,7 +83,7 @@ class CustomerClient():
         return self.client._delete(f"/{self.endpoint}/{str(id)}")
     
 
-    def query_invoices(
+    def query_customers (
         self,
         *,
         query: Optional[str] = None,

{spyreapi-0.0.2 → spyreapi-0.0.3}/src/spyre/sales.py

@@ -1,10 +1,12 @@
 from .client import APIResource
 from .Models.sales_models import SalesOrder, SalesOrderItem, Invoice
+from .Models.shared_models import Note
 from .utils import *
 from .client import SpireClient
 from urllib.parse import urlparse 
 from .Exceptions import CreateRequestError
 from typing import Any, Optional, List, Dict
+from .crm import note, CRMClient
 
 class OrdersClient():
 
@@ -37,7 +39,7 @@ class OrdersClient():
         Sends a POST request to the sales order endpoint .
 
         Args:
-            sales_order (dict): A SalesOrder instace containing the sales order details.
+            sales_order (dict): A SalesOrder instance containing the sales order details.
 
         Returns:
             salesOrder: The created SalesOrder instance.
@@ -129,6 +131,31 @@ class OrdersClient():
             **extra_params
         )
     
+    def create_sales_order_note(self, id: int , note_body : str, note_subject : str = "Note") -> note:
+        """
+        Create a new note on this sales order.
+
+        Args:
+            id (int): The id of the salesOrder to create a note on.
+            note (str): The body of the note 
+        Returns:
+            note: The created note
+
+        Raises:
+            CreateRequestError: If the creation fails or response is invalid.
+        """
+
+        note_model = Note(body=note_body, subject=note_subject)
+        response =  self.client._post(f"/{self.endpoint}/{id}/notes/", json=note_model.model_dump(exclude_unset=True, exclude_none=True))
+        if response.get('status_code') == 201:
+            location = response.get('headers').get('location')
+            parsed_url = urlparse(location)
+            path_segments = parsed_url.path.rstrip("/").split("/")
+            id = path_segments[-1]
+            return CRMClient(client=self.client).get_note(id)
+        else:
+            error_message = response.get('content')
+            raise CreateRequestError(self.endpoint, status_code=response.get('status_code'), error_message=error_message)
     
 class InvoiceClient():
     
@@ -277,6 +304,30 @@ class salesOrder(APIResource[SalesOrder]):
         response = self._client._put(f"/{self.endpoint}/{str(self.id)}", json=data)
         return salesOrder.from_json(response, self._client)    
 
+    def add_note(self, note_body : "str" , note_subject : "str" = "Note") -> note:
+        """
+        Add a note to this sales order
+
+        Args:
+            note_body (str): the body of the note.
+            note_subject (str, "Note"): the subject of the note. the defualt value is just "Note"
+
+        Returns:
+            note: The note created.
+        """
+
+        note_model = Note(body=note_body, subject=note_subject)
+        response =  self._client._post(f"/{self.endpoint}/{str(self.id)}/notes/", json=note_model.model_dump(exclude_unset=True, exclude_none=True))
+        if response.get('status_code') == 201:
+            location = response.get('headers').get('location')
+            parsed_url = urlparse(location)
+            path_segments = parsed_url.path.rstrip("/").split("/")
+            id = path_segments[-1]
+            return CRMClient(client=self._client).get_note(id)
+        else:
+            error_message = response.get('content')
+            raise CreateRequestError(f"/{self.endpoint}/{str(self.id)}/notes/", status_code=response.get('status_code'), error_message=error_message)
+
 class invoice(APIResource[Invoice]):
     endpoint = "sales/invoices/"
     Model = Invoice
@@ -310,4 +361,6 @@ class invoice(APIResource[Invoice]):
         """
         data = invoice_.model_dump(exclude_unset=True, exclude_none=True) if invoice_ else self.model_dump(exclude_unset=True, exclude_none=True)
         response = self._client._put(f"/{self.endpoint}/{str(self.id)}", json=data)
-        return invoice.from_json(response, self._client)   
+        return invoice.from_json(response, self._client)   
+    
+

{spyreapi-0.0.2 → spyreapi-0.0.3/src/spyreapi.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: spyreapi
-Version: 0.0.2
+Version: 0.0.3
 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
@@ -42,3 +42,20 @@ A robust and extensible Python client for interacting with the [Spire Business S
 
 ```bash
 pip install -r requirements.txt
+```
+
+---
+
+## ⚙️ Configuration
+
+- Before using the client, set up your environment configuration:
+
+### Add your Base URL to your spire server to a `.env` file
+
+- In your project root, create a `.env` file to securely store your Spire configuration.
+- Add the following variable:
+
+```env
+BASE_URL = https://{your-spire-domain}/api/v2/companies/
+```
+- Replace {your-spire-domain} with your actual Spire server's hostname or IP address.

{spyreapi-0.0.2 → spyreapi-0.0.3}/src/spyreapi.egg-info/SOURCES.txt

@@ -6,6 +6,7 @@ src/spyre/Exceptions.py
 src/spyre/__init__.py
 src/spyre/client.py
 src/spyre/config.py
+src/spyre/crm.py
 src/spyre/customers.py
 src/spyre/inventory.py
 src/spyre/sales.py
@@ -20,5 +21,4 @@ src/spyreapi.egg-info/PKG-INFO
 src/spyreapi.egg-info/SOURCES.txt
 src/spyreapi.egg-info/dependency_links.txt
 src/spyreapi.egg-info/requires.txt
-src/spyreapi.egg-info/top_level.txt
-tests/testing.py
+src/spyreapi.egg-info/top_level.txt

spyreapi-0.0.2/MANIFEST.in

@@ -1,3 +0,0 @@
-include README.md
-include LICENSE
-global-exclude *.pyc

spyreapi-0.0.2/tests/testing.py

@@ -1,378 +0,0 @@
-import spyre
-import spyre.spire
-
-"""
-Tested
-> Get Order
-> Pydantic Model
-> Creating Order
-> Deleting Order
-> Updating Order
-> Processing a order
-> Invoicing a order
-> Reversing a invoice(Check with eric)
-> Get Invoice
-> Update Invoice
-> Get Customer
-> Create Customer
-> Update Customer
-> Delete Customer
-> Querying
-> Filtering
-> Sorting
-
-
-Todo
-
-
->Exceptions (Duplicate , Processing quotes, Invalid inPuts)
->Documentation
->Response handling/ object -> Replace Riase_for_status
->Invoice Items/ Sales Order Item
->Payments, Deposit on Sales Order
->get by orderNo/invoiceNo etc
-
-# >Querying
-# >filtering and sorting
-# >Create returns the item created
-# >Customer
-# >Make Wrapper class and implemement Oob type classes & methods
-# >Create a model for Orders
-# >Test Create,Update,
-# >Processing Orders
-# >Cancel/Delete
-# >Return
-"""
-
-
-spire = Spire('intertest' , 'david1' , 'david')
-
-
-
-
-order = spire.orders.get_sales_order(51247)
-order.model.location = "01"
-print(order.update())
-
-# order = spire.orders.get_sales_order(51245)
-# print(order.invoice())
-
-TAXES = {
-    0.05 : 1,
-
-    0.08 : 2,
-    0.13 : 3,
-    0.15 : 4,
-    0.14 : 5,
-    0.12 : 6,
-    0.11 : 7 
-}
-
-order = {
-    "amazon-order-id": "702-6212155-2707463",
-    "merchant-order-id": "3045",
-    "purchase-date": "5/31/2025 23:22",
-    "last-updated-date": "6/2/2025 11:08",
-    "order-status": "Shipped",
-    "fulfillment-channel": "Merchant",
-    "sales-channel": "Amazon.ca",
-    "order-channel": "WebsiteOrderChannel",
-    "url": "",
-    "ship-service-level": "Standard",
-    "product-name": "20V MAX 1/2IN Compact Impact WR- HR",
-    "sku": "DEWDCF921B",
-    "asin": "B09M3TL9BB",
-    "number-of-items": 1,
-    "item-status": "Shipped",
-    "tax-collection-model": "",
-    "tax-collection-responsible-party": "",
-    "quantity": 1,
-    "currency": "CAD",
-    "item-price": 195,
-    "item-tax": 21.45,
-    "shipping-price": "",
-    "shipping-tax": "",
-    "gift-wrap-price": "",
-    "gift-wrap-tax": "",
-    "item-promotion-discount": "",
-    "ship-promotion-discount": "",
-    "address-type": "",
-    "ship-city": "Maple Creek",
-    "ship-state": "Saskatchewan",
-    "ship-postal-code": "S0N 1N0",
-    "ship-country": "CA",
-    "promotion-ids": "",
-    "is-business-order": False,
-    "purchase-order-number": "",
-    "price-designation": "",
-    "fulfilled-by": "",
-    "default-ship-from-address-name": "Interline Wholesale Hardware Distributors North",
-    "default-ship-from-address-field-1": "399 Confederation Parkway",
-    "default-ship-from-address-field-2": "",
-    "default-ship-from-address-field-3": "",
-    "default-ship-from-city": "Vaughan",
-    "default-ship-from-state": "Ontario",
-    "default-ship-from-country": "CA",
-    "default-ship-from-postal-code": "L4K 4S1",
-    "actual-ship-from-address-name": "Interline Wholesale Hardware Distributors North",
-    "actual-ship-from-address-field-1": "399 Confederation Parkway",
-    "actual-ship-from-address-field-2": "",
-    "actual-ship-from-address-field-3": "",
-    "actual-ship-from-city": "Vaughan",
-    "actual-ship-from-state": "Ontario",
-    "actual-ship-from-country": "CA",
-    "actual-ship-from-postal-code": "L4K 4S1",
-    "serial-numbers": ""
-}
-
-from datetime import datetime
-
-def convert_order_date(date_str: str) -> str:
-    try:
-        dt = datetime.strptime(date_str, "%m/%d/%Y %H:%M")
-        return dt.strftime("%Y-%m-%d")
-    except ValueError:
-        return ""
-    
-
-def get_tax_code(order: dict) -> int:
-    try:
-        item_price = float(order.get('item-price', 0))
-        item_tax = float(order.get('item-tax', 0))
-
-        if item_price == 0:
-            raise ValueError("Item price cannot be zero.")
-
-        tax_rate = item_tax / item_price
-        print(tax_rate)
-        # Find the closest tax rate key
-        closest_rate = min(TAXES.keys(), key=lambda r: abs(r - tax_rate))
-        print(closest_rate)
-        return TAXES[closest_rate]
-
-    except (TypeError, ValueError):
-        return None  # or raise an error if preferred
-
-
-def convert_order_to_sales_order(order: dict) -> SalesOrder:
-
-    amazn_id = order.get('amazon-order-id')
-    udf = {
-        "shopid" : amazn_id,
-        "shipped" : order.get('order-status') == 'shipped'
-    }
-
-    status = "O"
-    # if order.get('order-status') == 'shipped':
-    #     status = "H"
-    
-    tax_code = get_tax_code(order)
-
-    shipping_address = Address(city=order.get('ship-city'), provState= order.get('ship-state'), postalCode = order.get('ship-postal-code'), country=order.get('ship-country'),
-                               salesTaxes=[ { "code" : tax_code } ]
-                               )
-
-    items = []
-    item = SalesOrderItem(
-        inventory=Inventory(partNo=order.get("sku"), whse='00'),
-        partNo=order.get("sku"),
-        orderQty=str(order.get("quantity")),
-        unitPrice=str( float(order.get("item-price")) /float(order.get("quantity"))   ),
-        taxFlags= [True,True,True,True],
-        committedQty=str(order.get("quantity")),
-
-    )
-    
-    items.append(item)
-    freight = str(
-        float(order.get('shipping-tax', '0') or 0) - 
-        float(order.get('ship-promotion-discount', '0') or 0)
-    )
-
-    customer = Customer(customerNo="AMAZON")
-
-    return SalesOrder(
-        orderNo= "AMZN3" + amazn_id[-5:]  ,
-        orderDate=convert_order_date(order.get("purchase-date")),
-        type = "O",
-        referenceNo= amazn_id,
-        status=status,
-        currency=Currency(code=order.get("currency")) if order.get("currency") else None,
-        shippingAddress=shipping_address,
-        items=items,
-        udf=udf,
-        freight=freight,
-        customer=customer,
-
-    )
-
-sales_order = convert_order_to_sales_order(order)
-print(sales_order.model_dump_json(indent=2 , exclude_none= True))
-
-
-
-# order.model.payments = [ {"method" : "06" , "amount" : "216.45" , "layawayFlag" : False}]
-# order.update()
-# print(order.invoice())
-
-
-
-# uoms = spire.inventory.items.get_item_uoms(id = 811)
-# test_uom = uoms[2]
-# print(test_uom.description)
-
-
-# inv = spire.invoices.get_invoice(206363)
-# order_converted.
-# order_converted = create_sales_order_from_invoice(inv.model)
-# print(order_converted.model_dump_json(exclude_none=True, exclude_unset=True, indent=2))
-
-
-# cust = spire.customers.get_customer(1)
-
-# ord = spire.orders.get_sales_order(31319)
-# ord.customer = cust.model
-
-# print(ord.update())
-
-
-# order_test = json.loads("""
-                        
-# {
-#   "customer": {
-#     "id" : 3143
-#   },
-#   "currency": {
-#     "code": "CAD"
-                        
-#   },
-#   "address": {
-#     "country": "Can",
-#     "defaultWarehouse": "00",
-#     "line1": "629 Daintry Crescent",
-#     "line2": "Cobourg ON K9A 4X9",
-#     "email": "beatty731@yahoo.com",
-#     "contacts": [
-#       {
-#         "phone": {
-#           "number": "+1 905-207-1116"
-#         }
-#       }
-#     ]
-#   },
-#   "contact": {
-#     "phone": {
-#       "number": "+1 905-207-1116"
-#     },
-#     "name": "safdasd"
-#   },
-#   "shippingCarrier": "1",
-#   "referenceNo": "1",
-#   "trackingNo": "1",
-#   "shipDate": null,
-#   "items": [
-#     {
-#       "inventory": {
-#         "id": 12345,
-#         "whse": "00"
-#       }
-#     }
-#   ],
-#   "freight": "1",
-#   "discount": "1",
-#   "surcharge": "1",
-#   "status": "O",
-#   "type": "Q",
-#   "hold": false,
-#   "customerPO": "1"
-# }
-                        
-#                         """)
-
-
-
-# order = SalesOrder(**order_test)
-# print(order.model_dump(exclude_unset=True, ))
-
-
-
-# spire.orders.get_sales_order
-# invoice_test = spire.invoices.get_invoice(206362)
-# response = invoice_test.reverse()
-# print(response)
-
-# order = spire.orders.get_sales_order(31312)
-# response = order.invoice()
-
-# response = order.update_sales_order
-
-# order = spire.orders.get_sales_order(31307)
-# response = order.delete()
-# print(response)
-
-# resp = spire.orders.delete_sales_order(31306)
-# print(resp)
-
-
-
-# response = spire.orders.create_sales_order(order_test)
-# print(response)
-
-
-
-# orders_client = OrdersClient(client)
-# order = orders_client.get_order(12334)
-# order.invoice()
-
-
-# invoice_client = InvoiceClient(client)
-
-# response = invoice_client.reverse_invoice(206354)
-# print(response)
-
-# invoice_em = invoice_client.get_invoice(206355)
-# invoice_model = Invoice(**invoice_em)
-
-# print(invoice_model.model_dump_json(indent=2))
-
-# order_converted = create_sales_order_from_invoice(invoice_model)
-# print(order_converted.model_dump_json(indent=2, exclude_unset=True, exclude_none=True))
-
-# response = orders_client.create_order(order_converted.model_dump(exclude_unset=True, exclude_none=True))
-# print(response)
-
-
-# Get an order by ID
-# order_1001 = orders_client.get_order(1001)
-# try:
-#     orderModel = SalesOrder(**order_1001)  
-# except Exception as e:
-#     print(e.errors())
-
-# print(order)
-# print(orderModel.model_dump_json(indent=2))
-
-#Create an ORder
-
-
-
-# response = orders_client.create_order(order_test)
-# print(response)
-
-# deleting An order
-# response = orders_client.delete_order(31299)
-# print(response)
-
-# Updating an order
-# orderModel.location = "01"
-# print(orderModel.model_dump_json(indent=2))
-
-# response = orders_client.update_order(1001, orderModel.model_dump_json())
-# print(response)
-
-
-# order_test_model = SalesOrder(**order_test)
-# print(order_test_model.model_dump(exclude_none=True))
-
-
-