Sandbox updates

TM1py/Objects/Sandbox.py

@@ -12,14 +12,25 @@ class Sandbox(TM1Object):
 
     """
 
-    def __init__(self, name: str, include_in_sandbox_dimension: bool = True):
+    def __init__(
+        self, 
+        name: str, 
+        include_in_sandbox_dimension: bool = True,
+        loaded: bool = False,
+        active: bool = False,
+        queued: bool = False
+    ):
         """
 
         :param name: name of the Sandbox
-        :param include_in_sandbox_dimension: 
+        :param include_in_sandbox_dimension:
+        :params loaded, active, queued: leave default as false when creating sanbox 
         """
         self.name = name
         self.include_in_sandbox_dimension = include_in_sandbox_dimension
+        self.loaded = loaded
+        self.active = active
+        self.queued = queued
 
     @property
     def name(self) -> str:
@@ -57,6 +68,9 @@ def from_dict(cls, sandbox_as_dict: Dict) -> "Sandbox":
         return cls(
             name=sandbox_as_dict["Name"],
             include_in_sandbox_dimension=sandbox_as_dict["IncludeInSandboxDimension"],
+            loaded=sandbox_as_dict["IsLoaded"],
+            active=sandbox_as_dict["IsActive"],
+            queued=sandbox_as_dict["IsQueued"]
         )
 
     @property

TM1py/Services/SandboxService.py

@@ -126,3 +126,21 @@ def exists(self, sandbox_name: str, **kwargs) -> bool:
         """
         url = format_url("/api/v1/Sandboxes('{}')", sandbox_name)
         return self._exists(url, **kwargs)
+
+    def load(self, sandbox_name: str, **kwargs) -> Response:
+        """ load sandbox into memory
+
+        :param sandbox_name: str
+        :return: response
+        """
+        url = format_url("/api/v1/Sandboxes('{}')/tm1.Load", sandbox_name)
+        return self._rest.POST(url=url, **kwargs)
+
+    def unload(self, sandbox_name: str, **kwargs) -> Response:
+        """ unload sandbox from memory
+
+        :param sandbox_name: str
+        :return: response
+        """
+        url = format_url("/api/v1/Sandboxes('{}')/tm1.Unload", sandbox_name)
+        return self._rest.POST(url=url, **kwargs)

Tests/SandboxService_test.py

@@ -19,6 +19,7 @@ class TestSandboxService(unittest.TestCase):
         prefix + "dimension3"]
     sandbox_name1 = prefix + "sandbox1"
     sandbox_name2 = prefix + "sandbox2"
+    sandbox_name3 = prefix + "sandbox3"
 
     @classmethod
     def setUp(cls):
@@ -184,9 +185,31 @@ def test_merge_without_clean_after(self):
         values = self.tm1.cells.execute_mdx_values(mdx=mdx, sandbox_name=self.sandbox_name2)
         self.assertEqual(5, values[0])
 
+    def test_unload_sandbox(self):
+        sandbox3 = Sandbox(self.sandbox_name3, True)
+        self.tm1.sandboxes.create(sandbox3)
+        self.tm1.sandboxes.unload(sandbox3)
+
+        loaded = (self.tm1.sandboxes.get(self.sandbox_name3)).loaded
+        self.assertFalse(loaded)
+
+    def test_load_sandbox(self):
+        self.tm1.sandboxes.create(sandbox3)
+        self.tm1.sandboxes.load(sandbox3)
+
+        loaded = (self.tm1.sandboxes.get(self.sandbox_name3)).loaded
+        self.assertTrue(loaded)
+
+    def test_active_queued(self):
+        active = (self.tm1.sandboxes.get(self.sandbox_name3)).active
+        self.assertFalse(active)
+
+        queued = (self.tm1.sandboxes.get(self.sandbox_name3)).queued
+        self.assertFalse(queued)
+
     @classmethod
     def tearDown(cls):
-        for sandbox_name in [cls.sandbox_name1, cls.sandbox_name2]:
+        for sandbox_name in [cls.sandbox_name1, cls.sandbox_name2, cls.sandbox_name3]:
             if cls.tm1.sandboxes.exists(sandbox_name):
                 cls.tm1.sandboxes.delete(sandbox_name)