Support for Location Entities and Generic Read By Query (#20)

.gitignore

@@ -107,3 +107,4 @@ venv.bak/
 # Test files
 dry_run.py
 test.py
+test_scripts/

sageintacctsdk/apis/__init__.py

@@ -25,6 +25,7 @@
 from .dimension_values import DimensionValues
 from .tasks import Tasks
 from .expense_payment_types import ExpensePaymentTypes
+from .location_entities import LocationEntities
 
 __all_ = [
     'ApiBase',
@@ -50,5 +51,6 @@
     'Dimensions',
     'DimensionValues',
     'Tasks',
-    'ExpensePaymentTypes'
+    'ExpensePaymentTypes',
+    'LocationEntities'
 ]

sageintacctsdk/apis/api_base.py

@@ -285,6 +285,26 @@ def count(self):
         response = self.format_and_send_request(get_count)
         return int(response['data']['@totalcount'])
 
+    def read_by_query(self, fields: list = None):
+        """Read by Query from Sage Intacct
+
+        Parameters:
+            fields (list): Get selective fields to be returned. (optional).
+
+        Returns:
+            Dict.
+        """
+        payload = {
+            'readByQuery': {
+                'object': self.__dimension,
+                'fields': ','.join(fields) if fields else '*',
+                'query': None,
+                'pagesize': '1000'
+            }
+        }
+
+        return self.format_and_send_request(payload)
+
     def get(self, field: str, value: str, fields: list = None):
         """Get data from Sage Intacct based on filter.
 

sageintacctsdk/apis/constants.py

@@ -292,5 +292,37 @@
         'MEGAENTITYKEY',
         'MEGAENTITYID',
         'MEGAENTITYNAME'
+    ],
+    'LOCATIONENTITY': [
+        'RECORDNO',
+        'LOCATIONID',
+        'NAME',
+        'REPORTPRINTAS',
+        'SUPERVISORID',
+        'FIRSTMONTH',
+        'FIRSTMONTHTAX',
+        'WEEKSTART',
+        'FEDERALID',
+        'STARTDATE',
+        'ENDDATE',
+        'STATUS',
+        'HAS_IE_RELATION',
+        'CUSTOMERID',
+        'CUSTOMERNAME',
+        'VENDORID',
+        'VENDORNAME',
+        'CURRENCY',
+        'TAXID',
+        'ENABLELEGALCONTACT',
+        'LEGALNAME',
+        'LEGALADDRESS1',
+        'LEGALADDRESS2',
+        'LEGALCITY',
+        'LEGALSTATE',
+        'LEGALZIPCODE',
+        'LEGALCOUNTRY',
+        'OPCOUNTRY',
+        'ADDRESSCOUNTRYDEFAULT',
+        'RECORD_URL'
     ]
 }

sageintacctsdk/apis/location_entities.py

@@ -0,0 +1,10 @@
+"""
+Sage Intacct Location Entities
+"""
+from .api_base import ApiBase
+
+
+class LocationEntities(ApiBase):
+    """Class for Location Entities APIs."""
+    def __init__(self):
+        ApiBase.__init__(self, dimension='LOCATIONENTITY')

sageintacctsdk/sageintacctsdk.py

@@ -4,7 +4,7 @@
 from .apis import ApiBase, Contacts, Locations, Employees, Accounts, ExpenseTypes, Attachments, ExpenseReports,\
     Vendors, Bills, Projects, Departments, ChargeCardAccounts, ChargeCardTransactions, Customers, Items,\
     APPayments, Reimbursements, CheckingAccounts, SavingsAccounts, Tasks, ExpensePaymentTypes, Dimensions,\
-    DimensionValues
+    DimensionValues, LocationEntities
 
 
 class SageIntacctSDK:
@@ -52,6 +52,7 @@ def __init__(self, sender_id: str, sender_password: str, user_id: str, company_i
         self.dimension_values = DimensionValues()
         self.tasks = Tasks()
         self.expense_payment_types = ExpensePaymentTypes()
+        self.location_entities = LocationEntities()
 
         self.update_sender_id()
         self.update_sender_password()
@@ -85,6 +86,7 @@ def update_sender_id(self):
         self.dimension_values.set_sender_id(self.__sender_id)
         self.tasks.set_sender_id(self.__sender_id)
         self.expense_payment_types.set_sender_id(self.__sender_id)
+        self.location_entities.set_sender_id(self.__sender_id)
 
     def update_sender_password(self):
         """
@@ -114,6 +116,7 @@ def update_sender_password(self):
         self.dimension_values.set_sender_password(self.__sender_password)
         self.tasks.set_sender_password(self.__sender_password)
         self.expense_payment_types.set_sender_password(self.__sender_password)
+        self.location_entities.set_sender_password(self.__sender_password)
 
     def update_session_id(self):
         """
@@ -144,3 +147,4 @@ def update_session_id(self):
         self.dimension_values.set_session_id(self.__session_id)
         self.tasks.set_session_id(self.__session_id)
         self.expense_payment_types.set_session_id(self.__session_id)
+        self.location_entities.set_session_id(self.__session_id)

setup.py

@@ -8,7 +8,7 @@
 
 setuptools.setup(
     name='sageintacctsdk',
-    version='1.1.0',
+    version='1.2.0',
     author='Ashwin T',
     author_email='ashwin.t@fyle.in',
     description='Python SDK for accessing Sage Intacct APIs',