spyreapi 0.0.1__py3-none-any.whl

spyre/Exceptions.py

@@ -0,0 +1,45 @@
+
+"""
+>Cannot Convert Invoice to Quote
+>Inactive Item
+>invalide Syntax for date time
+>A database error has occurred:\n\nA value passed to the database was too long for the column - Country Name 
+>Order Number Exists
+>Invalid Customer
+>Missing Parent/Child errror -> id of addresses
+
+Contacts 3
+Request Failure
+Not Found
+invalid Field for filter
+
+
+{'status_code': 422, 'url': 'https://red-wave-8362.spirelan.com:10880/api/v2/companies/intertest/sales/orders/31308/invoice', 
+'content': {'type': 'error', 'message': 'Cannot post a deleted order', 'traceback': '', 'error_type': 'BusinessViolationError'}}
+"""
+
+class CreateRequestError(Exception):
+    """
+    Exception raised when a create (POST) request to the API fails.
+    """
+
+    def __init__(self, endpoint: str, status_code: int, error_message: str = "", response_body: dict = None):
+        self.endpoint = endpoint
+        self.status_code = status_code
+        self.error_message = error_message or "Unknown error occurred"
+        self.response_body = response_body or {}
+
+        super().__init__(self.__str__())
+
+    def __str__(self):
+        return (
+            f"Create request to '{self.endpoint}' failed with status {self.status_code}: {self.error_message}"
+        )
+
+    def to_dict(self):
+        return {
+            "endpoint": self.endpoint,
+            "status_code": self.status_code,
+            "error_message": self.error_message,
+            "response_body": self.response_body,
+        }

spyre/Models/customers_models.py

@@ -0,0 +1,40 @@
+from typing import List, Optional, Dict, Union, Any
+from pydantic import BaseModel, model_validator
+from Models.shared_models import *
+
+class Customer(BaseModel):
+    id: Optional[int] = None
+    code: Optional[str] = None
+    customerNo: Optional[str] = None
+    name: Optional[str] = None
+    foregroundColor: Optional[int] = None
+    backgroundColor: Optional[int] = None
+    hold: Optional[bool] = None
+    status: Optional[str] = None
+    reference: Optional[str] = None
+    address: Optional[Address] = None
+    shippingAddresses: Optional[List[Address]] = None
+    paymentTerms: Optional[Dict[str, Any]] = None
+    applyFinanceCharges: Optional[bool] = None
+    statementType: Optional[str] = None
+    creditType: Optional[int] = None
+    creditLimit: Optional[str] = None
+    creditBalance: Optional[str] = None
+    creditApprovedBy: Optional[str] = None
+    creditApprovedDate: Optional[str] = None
+    currency: Optional[str] = None 
+    userDef1: Optional[str] = None
+    userDef2: Optional[str] = None
+    discount: Optional[str] = None
+    receivableAccount: Optional[str] = None
+    defaultShipTo: Optional[str] = None
+    specialCode: Optional[str] = None
+    upload: Optional[bool] = None
+    lastModified: Optional[str] = None
+    paymentProviderId: Optional[int] = None
+    udf: Optional[Dict[str, Any]] = None
+    createdBy: Optional[str] = None
+    modifiedBy: Optional[str] = None
+    created: Optional[str] = None
+    modified: Optional[str] = None
+    links: Optional[Dict[str, str]] = None

spyre/Models/inventory_models.py

@@ -0,0 +1,160 @@
+from typing import List, Dict, Optional, Union
+from pydantic import BaseModel
+
+
+
+class UPC(BaseModel):
+    id: Optional[int] = None
+    whse: Optional[str] = None
+    partNo: Optional[str] = None
+    inventory: Optional[Dict] = None
+    uomCode: Optional[str] = None
+    upc: Optional[str] = None
+    created: Optional[str] = None
+    createdBy: Optional[str] = None
+    modified: Optional[str] = None
+    modifiedBy: Optional[str] = None
+    links: Optional[Dict[str, str]] = None
+
+class Vendor(BaseModel):
+    id: Optional[int] = None
+    vendorNo: Optional[str] = None
+    name: Optional[str] = None
+
+
+class UnitOfMeasure(BaseModel):
+    id: Optional[int] = None
+    code: Optional[str] = None
+    description: Optional[str] = None
+    location: Optional[str] = None
+    weight: Optional[str] = None
+    buyUOM: Optional[bool] = None
+    sellUOM: Optional[bool] = None
+    allowFractionalQty: Optional[bool] = None
+    quantityFactor: Optional[str] = None
+    directFactor: Optional[bool] = None
+
+
+class Pricing(BaseModel):
+    id: Optional[int] = None
+    sellPrices: Optional[List[str]] = None
+
+
+class ItemUDF(BaseModel):
+    desc: Optional[str] = None
+    brand: Optional[str] = None
+    model: Optional[str] = None
+    title: Optional[str] = None
+    online: Optional[bool] = None
+    pk_qty: Optional[str] = None
+    volume: Optional[str] = None
+    presale: Optional[bool] = None
+    sds_url: Optional[str] = None
+    tds_url: Optional[str] = None
+    features: Optional[str] = None
+    includes: Optional[str] = None
+    keywords: Optional[str] = None
+    op1_name: Optional[str] = None
+    op2_name: Optional[str] = None
+    op3_name: Optional[str] = None
+    op4_name: Optional[str] = None
+    asm_depth: Optional[str] = None
+    asm_width: Optional[str] = None
+    category1: Optional[str] = None
+    category2: Optional[str] = None
+    category3: Optional[str] = None
+    category4: Optional[str] = None
+    op1_value: Optional[str] = None
+    op2_value: Optional[str] = None
+    op3_value: Optional[str] = None
+    op4_value: Optional[str] = None
+    pkg_depth: Optional[str] = None
+    pkg_width: Optional[str] = None
+    asm_height: Optional[str] = None
+    asm_length: Optional[str] = None
+    asm_weight: Optional[str] = None
+    html_specs: Optional[str] = None
+    image_urls: Optional[str] = None
+    is_variant: Optional[bool] = None
+    pkg_height: Optional[str] = None
+    pkg_length: Optional[str] = None
+    pkg_weight: Optional[str] = None
+    put_online: Optional[bool] = None
+    upc_needed: Optional[bool] = None
+    video_urls: Optional[str] = None
+    hdr_part_no: Optional[str] = None
+    applications: Optional[str] = None
+    sell_through: Optional[bool] = None
+    unique_title: Optional[str] = None
+    alternate_res: Optional[str] = None
+    asm_weight_op: Optional[str] = None
+    html_includes: Optional[str] = None
+    more_info_url: Optional[str] = None
+    specsheet_url: Optional[str] = None
+    html_desc_feat: Optional[str] = None
+    specifications: Optional[str] = None
+    html_dimensions: Optional[str] = None
+    special_delivery: Optional[bool] = None
+    alternate_res_src: Optional[str] = None
+    html_applications: Optional[str] = None
+
+
+class InventoryItem(BaseModel):
+    id: Optional[int] = None
+    whse: Optional[str] = None
+    partNo: Optional[str] = None
+    description: Optional[str] = None
+    type: Optional[str] = None
+    status: Optional[int] = None
+    lotNumbered: Optional[bool] = None
+    serialized: Optional[bool] = None
+    availableQty: Optional[str] = None
+    onHandQty: Optional[str] = None
+    committedQty: Optional[str] = None
+    backorderQty: Optional[str] = None
+    onPurchaseQty: Optional[str] = None
+    foregroundColor: Optional[int] = None
+    backgroundColor: Optional[int] = None
+    primaryVendor: Optional[Vendor] = None
+    currentPONo: Optional[str] = None
+    poDueDate: Optional[str] = None
+    reorderPoint: Optional[str] = None
+    minimumBuyQty: Optional[str] = None
+    currentCost: Optional[str] = None
+    averageCost: Optional[str] = None
+    standardCost: Optional[str] = None
+    unitOfMeasures: Optional[Dict[str, UnitOfMeasure]] = None
+    buyMeasureCode: Optional[str] = None
+    stockMeasureCode: Optional[str] = None
+    sellMeasureCode: Optional[str] = None
+    alternatePartNo: Optional[str] = None
+    productCode: Optional[str] = None
+    groupNo: Optional[str] = None
+    salesDept: Optional[str] = None
+    userDef1: Optional[str] = None
+    userDef2: Optional[str] = None
+    discountable: Optional[bool] = None
+    weight: Optional[str] = None
+    packSize: Optional[str] = None
+    allowBackorders: Optional[bool] = None
+    allowReturns: Optional[bool] = None
+    dutyPct: Optional[str] = None
+    freightPct: Optional[str] = None
+    manufactureCountry: Optional[str] = None
+    harmonizedCode: Optional[str] = None
+    extendedDescription: Optional[str] = None
+    pricing: Optional[Dict[str, Pricing]] = None
+    salesTaxFlags: Optional[Dict[str, Union[str, int, float, bool]]] = None
+    images: Optional[List[str]] = None
+    defaultExpiryDate: Optional[str] = None
+    lotConsumeType: Optional[str] = None
+    upload: Optional[bool] = None
+    showOptions: Optional[bool] = None
+    lastModified: Optional[str] = None
+    levy: Optional[str] = None
+    udf: Optional[ItemUDF] = None
+    createdBy: Optional[str] = None
+    modifiedBy: Optional[str] = None
+    created: Optional[str] = None
+    modified: Optional[str] = None
+    links: Optional[Dict[str, Union[str, int, float, bool]]] = None

spyre/Models/sales_models.py

@@ -0,0 +1,170 @@
+from typing import List, Optional, Dict, Union
+from pydantic import BaseModel, model_validator
+from Models.shared_models import *
+from Models.customers_models import Customer
+
+class Inventory(BaseModel):
+    id: Optional[int] = None
+    whse: Optional[str] = None
+    partNo: Optional[str] = None
+    description: Optional[str] = None
+
+class SalesOrderItem(BaseModel):
+    id: Optional[int] = None
+    orderNo: Optional[str] = None
+    sequence: Optional[int] = None
+    parentSequence: Optional[int] = None
+    inventory: Optional[Inventory] = None
+    serials: Optional[str] = None
+    whse: Optional[str] = None
+    partNo: Optional[str] = None
+    description: Optional[str] = None
+    comment: Optional[str] = None
+    orderQty: Optional[str] = None
+    committedQty: Optional[str] = None
+    backorderQty: Optional[str] = None
+    sellMeasure: Optional[str] = None
+    retailPrice: Optional[str] = None
+    unitPrice: Optional[str] = None
+    userPrice: Optional[bool] = None
+    discountable: Optional[bool] = None
+    discountPct: Optional[str] = None
+    discountAmt: Optional[str] = None
+    currentCost: Optional[str] = None
+    averageCost: Optional[str] = None
+    standardCost: Optional[str] = None
+    taxFlags: Optional[List[bool]] = None
+    vendor: Optional[str] = None
+    inventoryAccountNo: Optional[str] = None
+    revenueAccountNo: Optional[str] = None
+    costOfGoodsAccountNo: Optional[str] = None
+    levyCode: Optional[str] = None
+    referenceNo: Optional[str] = None
+    requiredDate: Optional[str] = None
+    extendedPriceOrdered: Optional[str] = None
+    extendedPriceCommitted: Optional[str] = None
+    kit: Optional[bool] = None
+    suppress: Optional[bool] = None
+    udf: Optional[dict] = None
+
+
+class SalesOrder(BaseModel):
+    id: Optional[int] = None
+    orderNo: Optional[str] = None
+    division: Optional[str] = None
+    location: Optional[str] = None
+    profitCenter: Optional[str] = None
+    invoiceNo: Optional[str] = None
+    customer: Optional[Customer] = None
+    creditApprovedAmount: Optional[str] = None
+    creditApprovedDate: Optional[str] = None
+    creditApprovedUser: Optional[str] = None
+    currency: Optional[Currency] = None
+    status: Optional[str] = None
+    type: Optional[str] = None
+    hold: Optional[bool] = None
+    orderDate: Optional[str] = None
+    invoiceDate: Optional[str] = None
+    requiredDate: Optional[str] = None
+    quoteExpires: Optional[str] = None
+    recurrenceRule: Optional[str] = None
+    address: Optional[Address] = None
+    shippingAddress: Optional[Address] = None
+    contact: Optional[Contact] = None
+    customerPO: Optional[str] = None
+    batchNo: Optional[str] = None
+    fob: Optional[str] = None
+    incoterms: Optional[str] = None
+    incotermsPlace: Optional[str] = None
+    referenceNo: Optional[str] = None
+    shippingCarrier: Optional[str] = None
+    shipDate: Optional[str] = None
+    trackingNo: Optional[str] = None
+    termsCode: Optional[str] = None
+    termsText: Optional[str] = None
+    freight: Optional[str] = None
+    taxes: Optional[List[Tax]] = None
+    subtotal: Optional[str] = None
+    subtotalOrdered: Optional[str] = None
+    discount: Optional[str] = None
+    totalDiscount: Optional[str] = None
+    total: Optional[str] = None
+    totalOrdered: Optional[str] = None
+    totalCostCurrent: Optional[str] = None
+    totalCostAverage: Optional[str] = None
+    grossProfit: Optional[str] = None
+    items: Optional[List[SalesOrderItem]] = None
+    payments: Optional[List[dict]] = None
+    udf: Optional[dict] = None
+    createdBy: Optional[str] = None
+    modifiedBy: Optional[str] = None
+    created: Optional[str] = None
+    modified: Optional[str] = None
+    deletedBy: Optional[str] = None
+    deleted: Optional[str] = None
+    links: Optional[Dict[str, str]] = None
+    
+    @model_validator(mode="before")
+    @classmethod
+    def clean_problematic_fields(cls, data: dict) -> dict:
+        if data.get("currency") == "":
+            data["currency"] = None
+
+        contact = data.get("contact")
+        if contact:
+            for field in ("phone", "fax"):
+                phone_data = contact.get(field)
+                if isinstance(phone_data, dict) and phone_data.get("number") is None:
+                    phone_data["number"] = ""
+        return data
+
+class Invoice(BaseModel):
+    id: Optional[int] = None
+    invoiceNo: Optional[str] = None
+    orderNo: Optional[str] = None
+    division: Optional[str] = None
+    location: Optional[str] = None
+    profitCenter: Optional[str] = None
+    customer: Optional['Customer'] = None
+    currency: Optional['Currency'] = None
+    orderDate: Optional[str] = None
+    invoiceDate: Optional[str] = None
+    requiredDate: Optional[str] = None
+    address: Optional['Address'] = None
+    shippingAddress: Optional['Address'] = None
+    customerPO: Optional[str] = None
+    fob: Optional[str] = None
+    incoterms: Optional[str] = None
+    incotermsPlace: Optional[str] = None
+    referenceNo: Optional[str] = None
+    shippingCarrier: Optional[str] = None
+    shipDate: Optional[str] = None
+    trackingNo: Optional[str] = None
+    termsCode: Optional[str] = None
+    termsText: Optional[str] = None
+    freight: Optional[str] = None
+    taxes: Optional[List['Tax']] = None
+    subtotal: Optional[str] = None
+    total: Optional[str] = None
+    items: Optional[List['SalesOrderItem']] = None
+    payments: Optional[List[dict]] = None
+    udf: Optional[dict] = None
+    createdBy: Optional[str] = None
+    modifiedBy: Optional[str] = None
+    created: Optional[str] = None
+    modified: Optional[str] = None
+    links: Optional[Dict[str, str]] = None
+
+    @model_validator(mode="before")
+    @classmethod
+    def clean_problematic_fields(cls, data: dict) -> dict:
+        if data.get("currency") == "":
+            data["currency"] = None
+
+        contact = data.get("contact")
+        if contact:
+            for field in ("phone", "fax"):
+                phone_data = contact.get(field)
+                if isinstance(phone_data, dict) and phone_data.get("number") is None:
+                    phone_data["number"] = ""
+        return data

spyre/Models/shared_models.py

@@ -0,0 +1,96 @@
+from typing import List, Optional, Dict, Union
+from pydantic import BaseModel, model_validator
+
+class PhoneFax(BaseModel):
+    number: str
+    format: Optional[int] = 1
+
+class Contact(BaseModel):
+    id: Optional[int] = None
+    contact_type: Optional[dict] = None
+    name: Optional[str] = None
+    email: Optional[str] = None
+    phone: Optional[PhoneFax] = None
+    fax: Optional[PhoneFax] = None
+
+
+class Salesperson(BaseModel):
+    code: Optional[str] = None
+    name: Optional[str] = None
+
+class Territory(BaseModel):
+    code: Optional[str] = None
+    description: Optional[str] = None
+
+
+class Currency(BaseModel):
+    id: Optional[int] = None
+    code: Optional[str] = None
+    description: Optional[str] = None
+    country: Optional[str] = None
+    units: Optional[str] = None
+    fraction: Optional[str] = None
+    symbol: Optional[str] = None
+    decimalPlaces: Optional[int] = None
+    symbolPosition: Optional[str] = None
+    rate: Optional[str] = None
+    rateMethod: Optional[str] = None
+    glAccountNo: Optional[str] = None
+    thousandsSeparator: Optional[str] = None
+    lastYearRate: Optional[List[str]] = None
+    thisYearRate: Optional[List[str]] = None
+    nextYearRate: Optional[List[str]] = None
+
+
+class Tax(BaseModel):
+    code: Optional[int] = None
+    name: Optional[str] = None
+    shortName: Optional[str] = None
+    rate: Optional[Union[str, int]] = None
+    exemptNo: Optional[str] = None
+    total: Optional[Union[str, int]] = None    
+
+
+class Address(BaseModel):
+    id: Optional[int] = None
+    type: Optional[str] = None
+    linkTable: Optional[str] = None
+    linkType: Optional[str] = None
+    linkNo: Optional[str] = None
+    shipId: Optional[str] = None
+    name: Optional[str] = None
+    line1: Optional[str] = None
+    line2: Optional[str] = None
+    line3: Optional[str] = None
+    line4: Optional[str] = None
+    city: Optional[str] = None
+    postalCode: Optional[str] = None
+    provState: Optional[str] = None
+    country: Optional[str] = None
+    phone: Optional[PhoneFax] = None
+    fax: Optional[PhoneFax] = None
+    email: Optional[str] = None
+    website: Optional[str] = None
+    shipCode: Optional[str] = None
+    shipDescription: Optional[str] = None
+    salesperson: Optional[Salesperson] = None
+    territory: Optional[Territory] = None
+    sellLevel: Optional[int] = None
+    glAccount: Optional[str] = None
+    defaultWarehouse: Optional[str] = None
+    udf: Optional[dict] = None
+    created: Optional[str] = None
+    modified: Optional[str] = None
+    contacts: Optional[List[Contact]] = None
+    salesTaxes: Optional[List[Dict[str, Union[int, str]]]] = None
+    
+    @model_validator(mode="before")
+    @classmethod
+    def limit_contacts_to_three(cls, data):
+        """Limits contacts to 3 per address. The Spire API only allows Creatig/Updating Addresses with contacts."""
+
+        if isinstance(data, dict):
+            contacts = data.get('contacts')
+            if isinstance(contacts, list) and len(contacts) > 3:
+                data['contacts'] = contacts[:3]
+        return data

spyre/__init__.py

@@ -0,0 +1,22 @@
+from .client import SpireClient
+from .inventory import InventoryClient
+from .sales import OrdersClient, InvoiceClient, salesOrder, invoice
+from .Models.sales_models import SalesOrder, SalesOrderItem
+from .Models.inventory_models import InventoryItem, Vendor, UnitOfMeasure, Pricing, UPC
+
+__all__ = [
+    "SpireClient",
+    "InventoryClient",
+    "SalesOrderClient",
+    "SalesOrder",
+    "SalesOrderItem",
+    "InventoryItem",
+    "Vendor",
+    "UnitOfMeasure",
+    "Pricing",
+    "UPC",
+    "OrdersClient",
+    "InvoiceClient",
+    "salesOrder",
+    "invoice"
+]