spyreapi 0.0.6__tar.gz → 0.0.7__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: spyreapi
-Version: 0.0.6
+Version: 0.0.7
 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
@@ -26,6 +26,10 @@ A robust and extensible Python client for interacting with the [Spire Business S
 
 ---
 
+## Documentation
+
+https://sanjid-sharaf.github.io/spyre/
+
 ## ✨ Features
 
 - ✅ Object-oriented resource wrappers for each module (e.g., `salesOrder`, `invoice`, `item`)
@@ -41,7 +45,7 @@ A robust and extensible Python client for interacting with the [Spire Business S
 ## 📦 Installation
 
 ```bash
-pip install -r requirements.txt
+pip install spyreapi
 ```
 
 ---

{spyreapi-0.0.6 → spyreapi-0.0.7}/README.md

@@ -4,6 +4,10 @@ A robust and extensible Python client for interacting with the [Spire Business S
 
 ---
 
+## Documentation
+
+https://sanjid-sharaf.github.io/spyre/
+
 ## ✨ Features
 
 - ✅ Object-oriented resource wrappers for each module (e.g., `salesOrder`, `invoice`, `item`)
@@ -19,7 +23,7 @@ A robust and extensible Python client for interacting with the [Spire Business S
 ## 📦 Installation
 
 ```bash
-pip install -r requirements.txt
+pip install spyreapi
 ```
 
 ---

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

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

{spyreapi-0.0.6 → spyreapi-0.0.7}/src/spyre/__init__.py

@@ -12,7 +12,7 @@ __all__ = [
     "Spire",
     "ItemsClient",
     "InventoryClient",
-    "SalesOrderClient",
+    "OrdersClient",
     "SalesOrder",
     "SalesOrderItem",
     "InventoryItem",

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

@@ -7,14 +7,17 @@ from requests.exceptions import HTTPError, ConnectionError, Timeout, RequestExce
 T = TypeVar('T', bound=BaseModel)
 
 class SpireClient():    
-    """A lightweight client to interact with the Spire API using requests sessions for connection reuse and authenticated calls."""
+    """A lightweight to interact with the Spire API using requests sessions for connection reuse and authenticated calls."""
+    
     def __init__(self, host, company, username, password,):
         """
-        :param host (str): Spire Server host
-        :param company (str): Spire company
-        :param username (str): Spire user username.
-        :param password (str): Spire user password.
-        
+        Initialize a SpireClient instance.
+
+        Args:
+            host (str): Spire Server host.
+            company (str): Spire company.
+            username (str): Spire user username.
+            password (str): Spire user password.
         """
         self.session = requests.Session()
         self.session.auth = (username, password)
@@ -239,7 +242,7 @@ class APIResource(Generic[T]):
             setattr(self, k, v)
 
     def __getattr__(self, item):
-        """  delegate unknown attributes to the Pydantic model. 
+        """  Delegate unknown attributes to the Pydantic model. 
         if you try to access an attribute on your wrapper class that doesn't exist in that class.
         It will automatically forward the request to self._model """
         

{spyreapi-0.0.6 → spyreapi-0.0.7}/src/spyre/customers.py

@@ -98,13 +98,13 @@ class CustomerClient():
         Query customer with optional full-text search, filtering, multi-field sorting, and pagination.
 
         Args:
-            q (str, optional): Full-text search string.
+            query (str, optional): Full-text search string.
             sort (dict, optional): Dictionary of sorting rules (e.g., {"orderDate": "desc", "orderNo": "asc"}).
             filter (dict, optional): Dictionary of filters to apply (will be JSON-encoded and URL-safe).
             all (bool, optional): If True, retrieves all pages of results.
             limit (int, optional): Number of results per page (max 1000).
             start (int, optional): Starting offset for pagination.
-            **extra_params: Any additional parameters to include in the query.
+            **extra_params (Any): Any additional parameters to include in the query.
 
         Returns:
             List[customer]: List of wrapped customer resources.
@@ -127,7 +127,7 @@ class customer(APIResource[Customer]):
     Model = Customer
 
 
-    def delete(self):
+    def delete(self) -> bool:
         """
         Deletes the Customer from Spire.
 

{spyreapi-0.0.6 → spyreapi-0.0.7}/src/spyre/inventory.py

@@ -28,23 +28,40 @@ class ItemsClient():
         self.client = client
         self.endpoint = 'inventory/items'
 
-    def get_item(self, id) -> "item":
+    def get_item(self, id: int = None, part_no: str = None, warehouse: str = None) -> "item":
         """
-        Retrieve a inventory item by its ID.
+        Retrieve an inventory item by ID or (part_no + warehouse).
 
-        Sends a GET request to the Spire API to fetch a inentory item data for the
-        specified ID. Wraps the result in a `item` instance, which
-        retains a reference to the client for further actions.
+        Sends a GET request to the Spire API to fetch inventory item data for the
+        specified ID, or uses a filtered query with part number and warehouse.
+        Wraps the result in an `item` instance, which retains a reference to the
+        client for further actions.
 
         Args:
-            id (int): The ID of the sales order to retrieve.
+            id (int, optional): The ID of the inventory item to retrieve.
+            part_no (str, optional): The part number of the item to retrieve.
+            warehouse (str, optional): The warehouse code where the item is located.
 
         Returns:
-            salesOrder: A `item` wrapper instance containing the retrieved
-            data and a reference to the client session.
+            item: An `item` wrapper instance containing the retrieved data.
+
+        Raises:
+            ValueError: If neither ID nor (part_no and warehouse) are provided,
+                        or if no matching item is found.
         """
-        response = self.client._get(f"/{self.endpoint}/{str(id)}")
-        return item.from_json(response, self.client)
+        if id is not None:
+            response = self.client._get(f"/{self.endpoint}/{str(id)}")
+            return item.from_json(response, self.client)
+
+        elif part_no and warehouse:
+            items = self.query_inventory_items(filter={"partNo": part_no, "whse": warehouse})
+            for itm in items:
+                if getattr(itm, "partNo", None) == part_no and getattr(itm, "whse", None) == warehouse:
+                    return itm
+            raise ValueError(f"No item found with part_no='{part_no}' and warehouse='{warehouse}'.")
+
+        else:
+            raise ValueError("You must provide either 'id' or both 'part_no' and 'warehouse'.")
     
     def create_item(self, item : 'InventoryItem') -> 'item':
         """
@@ -74,7 +91,7 @@ class ItemsClient():
             raise CreateRequestError(self.endpoint, status_code=response.get('status_code'), error_message=error_message)
 
     
-    def update_item(self, id: int, inventory_item : 'InventoryItem') -> 'item':
+    def update_item(self, id: int, inventory_item : 'InventoryItem') -> "item":
         """
         Update an existing Inventory Item by ID.
 
@@ -84,7 +101,7 @@ class ItemsClient():
 
         Args:
             id (int): The ID of the item to update.
-            item (InventoryItem): A InventoryItem instance with the sales order details.
+            inventory_item (InventoryItem): A InventoryItem instance with the sales order details.
 
         Returns:
             item: An instance of the item wrapper class initialized with 
@@ -104,7 +121,7 @@ class ItemsClient():
             id (int): The ID of the inventory item to delete.
 
         Returns:
-            bool: True if the item was successfully deleted, False otherwise.
+            bool (bool): True if the item was successfully deleted, False otherwise.
         """
         return self.client._delete(f"/{self.endpoint}/{str(id)}")
     
@@ -124,13 +141,13 @@ class ItemsClient():
         Query inventory items with optional full-text search, filtering, multi-field sorting, and pagination.
 
         Args:
-            q (str, optional): Full-text search string.
+            query (str, optional): Full-text search string.
             sort (dict, optional): Dictionary of sorting rules (e.g., {"orderDate": "desc", "orderNo": "asc"}).
             filter (dict, optional): Dictionary of filters to apply (will be JSON-encoded and URL-safe).
             all (bool, optional): If True, retrieves all pages of results.
             limit (int, optional): Number of results per page (max 1000).
             start (int, optional): Starting offset for pagination.
-            **extra_params: Any additional parameters to include in the query.
+            **extra_params (Any): Any additional parameters to include in the query.
 
         Returns:
             List[item]: List of wrapped sales order resources.
@@ -166,7 +183,6 @@ class ItemsClient():
         items = response.get('records')
         for item in items:
             uoms.append(uom.from_json(json_data=item, client = self.client, item_id = id))
-
         return uoms
 
     def get_uom(self, item_id :int , uom_id : int) -> "uom":
@@ -186,10 +202,10 @@ class ItemsClient():
 
         """
         response = self.client._get(f"/{self.endpoint}/{str(item_id)}/uoms/{str(uom_id)}")
-        return uom.from_json(response, self.client)
+        return uom.from_json(response, self.client , item_id = item_id)
     
 
-    def create_item_uom(self, id: int, uom : UnitOfMeasure) -> List["uom"]:
+    def create_item_uom(self, id: int, uom : UnitOfMeasure) -> "uom":
         """
         Create a new Unit of Measure (UOM) for a specific inventory item.
 
@@ -212,8 +228,8 @@ class ItemsClient():
             location = response.get('headers').get('location')
             parsed_url = urlparse(location)
             path_segments = parsed_url.path.rstrip("/").split("/")
-            id = path_segments[-1]
-            return self.get_uom(id)
+            new_uom_id = path_segments[-1]
+            return self.get_uom(item_id=id, uom_id=new_uom_id)
         else:
             error_message = response.get('content')
             raise CreateRequestError(self.endpoint, status_code=response.get('status_code'), error_message=error_message)
@@ -234,7 +250,7 @@ class ItemsClient():
         """
         return self.client._delete(f"/{self.endpoint}/{str(item_id)}/uoms/{str(uom_id)}")
     
-    def update_item_uom(self, item_id: int, uom_id : int, uom :'uom') -> 'uom':
+    def update_item_uom(self, item_id: int, uom_id : int, uom_record :'uom') -> 'uom':
         """
         Update an existing Unit of Measure (UOM) for a given inventory item.
 
@@ -249,8 +265,8 @@ class ItemsClient():
         Returns:
             uom: The updated `uom` instance returned from the API.
         """
-        response = self.client._put(f"/{self.endpoint}/{str(item_id)}/{str(uom_id)}", json=uom.model_dump(exclude_none=True, exclude_unset=True))
-        return uom.from_json(response, self.client)
+        response = self.client._put(f"/{self.endpoint}/{str(item_id)}/uoms/{str(uom_id)}", json=uom_record.model_dump(exclude_none=True, exclude_unset=True))
+        return uom.from_json(response, self.client, item_id = item_id)
     
 
     def get_item_upcs(self, id : int) -> List["upc"]:
@@ -274,18 +290,95 @@ class ItemsClient():
 
         return upcs
     
+    def get_upc(self, item_id :int , upc_id : int) -> "upc":
+        """
+        Retrieve a specific UPC (upc) for a given inventory item.
+
+        This method sends a GET request to the Spire API to fetch a single upc record
+        associated with a specific inventory item and upc ID. The response is wrapped
+        into a `upc` object that maintains a reference to the API client.
+
+        Args:
+            item_id (int): The unique ID of the inventory item.
+            upc_id (int): The unique ID of the upc to retrieve.
+
+        Returns:
+            upc: A `upc` object representing the retrieved unit of measure.
+
+        """
+        response = self.client._get(f"/{self.endpoint}/{str(item_id)}/upcs/{str(upc_id)}")
+        return upc.from_json(response, self.client , item_id = item_id)
+    
+    def create_item_upc(self, id: int, upc : UPC) -> "upc":
+        """
+        Create a new UPC (upc) for a specific inventory item.
+
+        Sends a POST request to the Spire API to create a new upc for the inventory item
+        with the specified ID. If successful, the method retrieves and returns the newly
+        created upc object. If the creation fails, an exception is raised.
+
+        Args:
+            id (int): The ID of the inventory item for which to create the upc.
+            upc (UPC): A Pydantic model instance representing the upc to create.
+
+        Returns:
+            List[upc]: A list containing the created `upc` object.
+
+        Raises:
+            CreateRequestError: If the API response status is not 201 (Created).
+        """
+        response =  self.client._post(f"/{self.endpoint}/{str(id)}/upcs", json=upc.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("/")
+            new_upc_id = path_segments[-1]
+            return self.get_upc(item_id=id, upc_id = new_upc_id)
+        else:
+            error_message = response.get('content')
+            raise CreateRequestError(self.endpoint, status_code=response.get('status_code'), error_message=error_message)
+
+    def delete_upc(self, item_id : int, upc_id :int) -> bool:
+        """
+        Delete a UPC (upc) from a specific inventory item.
+
+        Sends a DELETE request to the Spire API to remove a upc associated with the
+        given item and upc ID.
+
+        Args:
+            item_id (int): The ID of the inventory item.
+            upc_id (int): The ID of the Unit of Measure to delete.
+
+        Returns:
+            bool: True if the deletion was successful, otherwise raises an error.
+        """
+        return self.client._delete(f"/{self.endpoint}/{str(item_id)}/upcs/{str(upc_id)}")
+    
+    def update_item_upc(self, item_id: int, upc_id : int, upc_record :'upc') -> 'upc':
+        """
+        Update an existing UPC (upc) for a given inventory item.
+
+        Sends a PUT request to the Spire API to update the upc record with the specified
+        item and upc ID using the provided `upc` data.
+
+        Args:
+            item_id (int): The ID of the inventory item.
+            upc_id (int): The ID of the upc to update.
+            upc (upc): A `upc` instance with updated field values.
+
+        Returns:
+            upc: The updated `upc` instance returned from the API.
+        """
+        response = self.client._put(f"/{self.endpoint}/{str(item_id)}/upcs/{str(upc_id)}", json=upc_record.model_dump(exclude_none=True, exclude_unset=True))
+        return upc.from_json(response, self.client, item_id = item_id)
+    
 
 class item(APIResource[InventoryItem]):
     
     endpoint =  'inventory/items'
     Model = InventoryItem
 
-    """
-    #TODO Check Upload, Add Uom & UPC, Add Price Matrix Record, Setting Sell & Buy UOM
-
-    """
-
-    def delete(self):
+    def delete(self) -> bool:
         """
         Cancels or deletes the item.
 
@@ -332,8 +425,25 @@ class item(APIResource[InventoryItem]):
 
         return uoms
     
+    def get_upcs(self) -> List["upc"]:
+        """
+        Retrieve all UPC records for the current inventory item.
+
+        This method sends a GET request to the Spire API and returns all UPCs
+        associated with this item's ID.
+
+        Returns:
+            List[upc]: A list of `upc` instances representing the available units of measure.
+        """     
+        upcs = []
+        response = self._client._get(f"{self.endpoint}/{self.id}/upcs")
+        items = response.get('records')
+        for item in items:
+            upcs.append(upc.from_json(json_data=item, client = self._client, item_id = id))
+
+        return upcs
 
-    def add_uom(self, uom : UnitOfMeasure) -> List["uom"]:
+    def add_uom(self, uom_record : UnitOfMeasure) -> "uom":
         """
         Add a new Unit of Measure (UOM) to the current inventory item.
 
@@ -345,22 +455,49 @@ class item(APIResource[InventoryItem]):
             uom (UnitOfMeasure): The UnitOfMeasure Pydantic model to be created.
 
         Returns:
-            List[uom]: A list containing the newly created `uom` instance.
+            uom (uom): The newly created Unit of measure as a `uom` instance.
 
         Raises:
             CreateRequestError: If the API returns a non-201 status code during creation.
         """
-        response =  self.client._post(f"/{self.endpoint}/{str(self.id)}/uoms", json=uom.model_dump(exclude_unset=True, exclude_none=True))
+        response =  self._client._post(f"/{self.endpoint}/{str(self.id)}/uoms", json=uom_record.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 self.get_uom(id)
+            return InventoryClient(self._client).items.get_uom(id)
         else:
             error_message = response.get('content')
             raise CreateRequestError(self.endpoint, status_code=response.get('status_code'), error_message=error_message)
+        
+    def add_upc(self, upc_record : UPC) -> "upc":
+        """
+        Add a new UPC to the current inventory item.
+
+        Sends a POST request to the Spire API to create a new UPC record using the provided
+        UPC model. If the creation is successful (HTTP 201), it retrieves
+        and returns the created UPC.
+
+        Args:
+            uom_record (UPC): The UPC Pydantic model to be created.
 
+        Returns:
+            upc (upc): The newly created UPC as a `upc` instance.
+
+        Raises:
+            CreateRequestError: If the API returns a non-201 status code during creation.
+        """
+        response =  self._client._post(f"/{self.endpoint}/{str(self.id)}/upcs", json=upc_record.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 InventoryClient(self._client).items.get_upc(id)
+        else:
+            error_message = response.get('content')
+            raise CreateRequestError(self.endpoint, status_code=response.get('status_code'), error_message=error_message)
     
 class uom(APIResource[UnitOfMeasure]):
     Model = UnitOfMeasure
@@ -375,7 +512,7 @@ class uom(APIResource[UnitOfMeasure]):
         self._endpoint = f'inventory/items/{item_id}/uoms/{str(uom_id)}'
         self._item_id = item_id
 
-    def delete(self):
+    def delete(self) -> bool:
         """
         Cancels or deletes the uom.
 
@@ -395,7 +532,7 @@ class uom(APIResource[UnitOfMeasure]):
         If an uom object is provided, updates the item using the given data.
 
         Args:
-            uom (uom, optional): An optional uom instance to use for the update.
+            _uom (uom, optional): An optional uom instance to use for the update.
 
         Returns:
             uom: The updated uom object reflecting the new status.
@@ -408,15 +545,127 @@ class UpcClient():
 
     def __init__(self, client : SpireClient):
         self.endpoint = 'inventory/upcs'
+        self.client = client
+
+    def get_upc(self, upc_id : int) -> "upc":
+        """
+        Retrieve a specific UPC (upc) for given id.
+
+        This method sends a GET request to the Spire API to fetch a single upc record
+        associated with the upc ID. The response is wrapped
+        into a `upc` object that maintains a reference to the API client.
+
+        Args:
+            upc_id (int): The unique ID of the upc to retrieve.
+
+        Returns:
+            upc: A `upc` object representing the retrieved unit of measure.
+
+        """
+        response = self.client._get(f"/{self.endpoint}/{str(upc_id)}")
+        return upc.from_json(response, self.client)
+    
+    def create_item_upc(self, upc : UPC) -> "upc":
+        """
+        Create a new UPC (upc) for a given id.
+
+        Sends a POST request to the Spire API to create a new upc.
+        If successful, the method retrieves and returns the newly
+        created upc object. If the creation fails, an exception is raised.
+        For a successful creation, either the whse and the partNo or the inventory
+        field has to be filled in
+
+        Args:
+            upc (UPC): A Pydantic model instance representing the upc to create.
+
+        Returns:
+            upc (upc): A list containing the created `upc` object.
+
+        Raises:
+            CreateRequestError: If the API response status is not 201 (Created).
+        """
+        response =  self.client._post(f"/{self.endpoint}/{str(id)}", json=upc.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("/")
+            new_upc_id = path_segments[-1]
+            return self.get_upc(upc_id = new_upc_id)
+        else:
+            error_message = response.get('content')
+            raise CreateRequestError(self.endpoint, status_code=response.get('status_code'), error_message=error_message)
+
+    def delete_upc(self, upc_id :int) -> bool:
+        """
+        Delete a UPC.
+
+        Sends a DELETE request to the Spire API to remove a upc associated with the
+        given upc ID.
+
+        Args:
+            upc_id (int): The ID of the Unit of Measure to delete.
+
+        Returns:
+            bool: True if the deletion was successful, otherwise raises an error.
+        """
+        return self.client._delete(f"/{self.endpoint}/{str(upc_id)}")
+    
+    def update_item_upc(self, upc_id : int, upc_record :'upc') -> 'upc':
+        """
+        Update an existing UPC.
+
+        Sends a PUT request to the Spire API to update the upc record with the specified
+        upc ID using the provided `upc` data.
+
+        Args:
+            upc_id (int): The ID of the upc to update.
+            upc (upc): A `upc` instance with updated field values.
+
+        Returns:
+            upc: The updated `upc` instance returned from the API.
+        """
+        response = self.client._put(f"/{self.endpoint}/{str(upc_id)}", json=upc_record.model_dump(exclude_none=True, exclude_unset=True))
+        return upc.from_json(response, self.client)
 
 class upc(APIResource[UPC]):
     _endpoint = ''         
-    Model = ''
+    Model = UPC
 
     def __init__(self, model, client, item_id=None):
-        if item_id is None:
-            raise ValueError("item_id must be provided")
+
         super().__init__(model, client)
         upc_id = model.id
-        self._endpoint = f'inventory/items/{item_id}/upcs/{str(upc_id)}'
-        self._item_id = item_id
+        if item_id is None:
+            self._endpoint = f'inventory/upcs/{str(upc_id)}'
+        else:
+            self._endpoint = f'inventory/items/{item_id}/upcs/{str(upc_id)}'
+        self._item_id = item_id
+
+    def delete(self) -> bool:
+        """
+        Cancels or deletes the upc.
+
+        Sends a DELETE request to the API to remove the upc with the current ID.
+
+        Returns:
+            bool: True if the upc was successfully deleted (HTTP 204 or 200), False otherwise.
+        """
+        
+        return self._client._delete(f"/{self._endpoint}")
+    
+    def update(self, _upc: "upc" = None) -> 'upc':
+        """
+        Update the upc.
+
+        If no upc object is provided, updates the current instance on the server.
+        If an upc object is provided, updates the item using the given data.
+
+        Args:
+            _upc (upc, optional): An optional upc instance to use for the update.
+
+        Returns:
+            upc: The updated upc object reflecting the new status.
+        """
+        data = _upc.model_dump(exclude_unset=True, exclude_none=True) if _upc else self.model_dump(exclude_unset=True, exclude_none=True)
+        response = self._client._put(f"/{self._endpoint}", json=data)
+        return upc.from_json(response, self._client, item_id = self._item_id)    

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

@@ -36,7 +36,7 @@ class OrdersClient():
             for order in orders:
                 if getattr(order, "orderNo", None) == order_number:
                     return order
-            return None
+            raise ValueError(f"No order found for order number {order_number}")
         else:
             raise ValueError("Either 'id' or 'order_number' must be provided.")
     
@@ -116,13 +116,13 @@ class OrdersClient():
         Query sales orders with optional full-text search, filtering, multi-field sorting, and pagination.
 
         Args:
-            q (str, optional): Full-text search string.
+            query (str, optional): Full-text search string.
             sort (dict, optional): Dictionary of sorting rules (e.g., {"orderDate": "desc", "orderNo": "asc"}).
             filter (dict, optional): Dictionary of filters to apply (will be JSON-encoded and URL-safe).
             all (bool, optional): If True, retrieves all pages of results.
             limit (int, optional): Number of results per page (max 1000).
             start (int, optional): Starting offset for pagination.
-            **extra_params: Any additional parameters to include in the query.
+            **extra_params (Any): Any additional parameters to include in the query.
 
         Returns:
             List[salesOrder]: List of wrapped sales order resources.
@@ -145,7 +145,8 @@ class OrdersClient():
 
         Args:
             id (int): The id of the salesOrder to create a note on.
-            note (str): The body of the note 
+            note_body (str): The body of the note. 
+            note_subject (str): The subject of the note.
         Returns:
             note: The created note
 
@@ -217,13 +218,13 @@ class InvoiceClient():
         Query invoices with optional full-text search, filtering, multi-field sorting, and pagination.
 
         Args:
-            q (str, optional): Full-text search string.
+            query (str, optional): Full-text search string.
             sort (dict, optional): Dictionary of sorting rules (e.g., {"orderDate": "desc", "orderNo": "asc"}).
             filter (dict, optional): Dictionary of filters to apply (will be JSON-encoded and URL-safe).
             all (bool, optional): If True, retrieves all pages of results.
             limit (int, optional): Number of results per page (max 1000).
             start (int, optional): Starting offset for pagination.
-            **extra_params: Any additional parameters to include in the query.
+            **extra_params (Any): Any additional parameters to include in the query.
 
         Returns:
             List[invoice]: List of wrapped invoice resources.
@@ -245,7 +246,7 @@ class salesOrder(APIResource[SalesOrder]):
     endpoint = "sales/orders/"
     Model = SalesOrder 
 
-    def invoice(self):
+    def invoice(self) -> "invoice":
         """
         Invoice the current sales order.
 
@@ -253,8 +254,10 @@ class salesOrder(APIResource[SalesOrder]):
         Note that quotes (salesOrder with type "Q") cannot be invoiced.
 
         Returns:
-            invoice: The created invoice object if successful.
-            dict: The full response if invoicing failed.
+            invoice (invoice): The created invoice object if successful.
+
+        Raises:
+            CreateRequestError: If invoice creation failed.
  
         """
         response = self._client._post(f"/{self.endpoint}/{str(self.id)}/invoice")
@@ -280,7 +283,7 @@ class salesOrder(APIResource[SalesOrder]):
         )
         return salesOrder.from_json(response, self._client)
     
-    def delete(self):
+    def delete(self) -> bool:
         """
         Cancels or deletes the sales order.
 
@@ -337,7 +340,7 @@ class invoice(APIResource[Invoice]):
     endpoint = "sales/invoices/"
     Model = Invoice
 
-    def reverse(self):
+    def reverse(self) -> salesOrder:
         """
         Convert this invoice into a sales order.
 
@@ -359,7 +362,7 @@ class invoice(APIResource[Invoice]):
         If no order object is provided, updates the current instance on the server.
 
         Args:
-            invoice (Invoice): The Invoice model instance containing updated data.
+            invoice_ (Invoice): The Invoice model instance containing updated data.
 
         Returns:
             invoice: The updated invoice instance created from the response data.

spyreapi-0.0.7/src/spyre/spire.py

@@ -0,0 +1,36 @@
+from .client import SpireClient
+from .sales import OrdersClient, InvoiceClient
+from .customers import CustomerClient
+from .inventory import InventoryClient
+
+class Spire:
+    """
+    High-level interface to interact with the Spire API.
+
+    This class wraps the lower-level API clients (Orders, Invoices, Customers, Inventory) into a unified interface,
+    initializing them using shared authentication via `SpireClient`.
+
+    Attributes:
+        client (SpireClient): Authenticated Spire API client.
+        orders (OrdersClient): Client for accessing sales orders.
+        invoices (InvoiceClient): Client for accessing invoices.
+        customers (CustomerClient): Client for accessing customer records.
+        inventory (InventoryClient): Client for accessing inventory items.
+    """
+    def __init__(self, host : str, company : str, username : str, password : str):
+        """
+        Creates a Spire session.
+
+        Args:
+            host (str): Spire Server host (e.g., black-disk-5630.spirelan.com:10880).
+            company (str): Spire company.
+            username (str): Spire user username.
+            password (str): Spire user password.
+        """
+        self.client = SpireClient(host, company, username, password)
+        self.orders = OrdersClient(self.client)
+        self.invoices = InvoiceClient(self.client)
+        self.customers = CustomerClient(self.client)
+        self.inventory = InventoryClient(self.client)
+
+

{spyreapi-0.0.6 → spyreapi-0.0.7}/src/spyre/utils.py

@@ -75,21 +75,24 @@ def create_duplicate_record(
     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
-
+    """
+    Creates a Sales Order from an Invoice by copying relevant fields 
+    and adjusting quantities and freight charges for order processing.
+
+    Args:
+        invoice (Invoice): The invoice object to convert.
+
+    Returns:
+        SalesOrder: A new Sales Order instance populated with data from the invoice,
+            including negative freight and order quantities, and duplicated
+            address and item records.
+
+    Notes:
+        - Freight amount is negated.
+        - Order and committed quantities are negated unless zero.
+        - Shipping carrier and tracking number fields are reset to None.
+        - Duplicate records are created for address, shipping address, and items 
+          to avoid mutating the original invoice data.
     """
 
 

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: spyreapi
-Version: 0.0.6
+Version: 0.0.7
 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
@@ -26,6 +26,10 @@ A robust and extensible Python client for interacting with the [Spire Business S
 
 ---
 
+## Documentation
+
+https://sanjid-sharaf.github.io/spyre/
+
 ## ✨ Features
 
 - ✅ Object-oriented resource wrappers for each module (e.g., `salesOrder`, `invoice`, `item`)
@@ -41,7 +45,7 @@ A robust and extensible Python client for interacting with the [Spire Business S
 ## 📦 Installation
 
 ```bash
-pip install -r requirements.txt
+pip install spyreapi
 ```
 
 ---

spyreapi-0.0.6/src/spyre/spire.py

@@ -1,23 +0,0 @@
-from .client import SpireClient
-from .sales import OrdersClient, InvoiceClient
-from .customers import CustomerClient
-from .inventory import InventoryClient
-
-class Spire:
-    def __init__(self, host : str, company : str, username : str, password : str):
-        """
-        Creates a spire Session
-
-        :param host (str): Spire Server host. eg: black-disk-5630.spirelan.com:10880
-        :param company (str): Spire company
-        :param username (str): Spire user username.
-        :param password (str): Spire user password.
-        
-        """
-        self.client = SpireClient(host, company, username, password)
-        self.orders = OrdersClient(self.client)
-        self.invoices = InvoiceClient(self.client)
-        self.customers = CustomerClient(self.client)
-        self.inventory = InventoryClient(self.client)
-
-