spyreapi 0.0.4__tar.gz → 0.0.6__tar.gz

{spyreapi-0.0.4/src/spyreapi.egg-info → spyreapi-0.0.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: spyreapi
-Version: 0.0.4
+Version: 0.0.6
 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

{spyreapi-0.0.4 → spyreapi-0.0.6}/pyproject.toml

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

{spyreapi-0.0.4 → spyreapi-0.0.6}/src/spyre/client.py

@@ -2,7 +2,6 @@ import requests
 from typing import TypeVar, Optional, Type, Generic, List, Union, Tuple, Dict, Any
 from pydantic import BaseModel
 import json
-import urllib.parse
 from requests.exceptions import HTTPError, ConnectionError, Timeout, RequestException
 
 T = TypeVar('T', bound=BaseModel)
@@ -79,9 +78,14 @@ class SpireClient():
 
         Returns:
             dict: A dictionary containing the response status code, URL, content, and headers.
+       
+        Raises:
+            requests.exceptions.HTTPError: If the response contains an HTTP error status.
         """
+        
         url = f"{self.base_url}/{endpoint.lstrip('/')}"
         response = self.session.post(url, data=data, json=json)
+        response.raise_for_status()
         return self._handle_response(response)
 
     def _put(self, endpoint, data=None, json=None):
@@ -94,11 +98,15 @@ class SpireClient():
             json (dict, optional): JSON data to send in the body of the request.
 
         Returns:
-            dict: A dictionary containing the response status code, URL, content, and headers.
+            dict: The JSON-decoded response from the API.
+        
+        Raises:
+            requests.exceptions.HTTPError: If the response contains an HTTP error status.
         """
         url = f"{self.base_url}/{endpoint.lstrip('/')}"
         response = self.session.put(url, data=data, json=json)
-        return self._handle_response(response)
+        response.raise_for_status()
+        return response.json()
 
     def _delete(self, endpoint):
         """

{spyreapi-0.0.4 → spyreapi-0.0.6}/src/spyre/sales.py

@@ -14,24 +14,32 @@ class OrdersClient():
         self.client = client
         self.endpoint = "sales/orders"
     
-    def get_sales_order(self,  id: int, ) -> "salesOrder":
+    def get_sales_order(self, id: int = None, order_number: str = None) -> "salesOrder":
         """
-        Retrieve a sales order by its ID.
-
-        Sends a GET request to the Spire API to fetch sales order data for the
-        specified ID. Wraps the result in a `salesOrder` instance, which
-        retains a reference to the client for further actions.
+        Retrieve a sales order by its ID or order number.
 
         Args:
-            id (int): The ID of the sales order to retrieve.
+            id (int, optional): The ID of the sales order to retrieve.
+            order_number (str, optional): The order number of the sales order to retrieve.
 
         Returns:
-            salesOrder: A `salesOrder` wrapper instance containing the retrieved
-            data and a reference to the client session.
-        """
-        response = self.client._get(f"/{self.endpoint}/{str(id)}")
-        return salesOrder.from_json(response, self.client)
+            salesOrder: A `salesOrder` wrapper instance containing the retrieved data.
 
+        Raises:
+            ValueError: If neither id nor order_number is provided, or if no matching order is found.
+        """
+        if id is not None:
+            response = self.client._get(f"/{self.endpoint}/{str(id)}")
+            return salesOrder.from_json(response, self.client)
+        elif order_number is not None:
+            orders = self.query_sales_orders(query=order_number)
+            for order in orders:
+                if getattr(order, "orderNo", None) == order_number:
+                    return order
+            return None
+        else:
+            raise ValueError("Either 'id' or 'order_number' must be provided.")
+    
     def create_sales_order(self, sales_order : 'SalesOrder') -> 'salesOrder':
         """
         Create a new sales order.

{spyreapi-0.0.4 → spyreapi-0.0.6/src/spyreapi.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: spyreapi
-Version: 0.0.4
+Version: 0.0.6
 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