Updated docstrings

Author: jhodges10

frameioclient/service/assets.py

@@ -60,7 +60,7 @@ def from_url(self, parent_asset_id, name, url):
 
       Example::
 
-        client.create_asset(
+        client.assets.from_url(
           parent_asset_id="123abc",
           name="ExampleFile.mp4",
           type="file",
@@ -70,6 +70,7 @@ def from_url(self, parent_asset_id, name, url):
 
     payload = {
       "name": name,
+      "type": "file",
       "source": {
         "url": url
       }
@@ -88,7 +89,7 @@ def update(self, asset_id, **kwargs):
       the fields to update
 
       Example::
-        client.update_asset("adeffee123342", name="updated_filename.mp4")
+        client.assets.update("adeffee123342", name="updated_filename.mp4")
     """
     endpoint = '/assets/{}'.format(asset_id)
     return self.client._api_call('put', endpoint, kwargs)
@@ -103,7 +104,7 @@ def copy(self, destination_folder_id, **kwargs):
       id (string): The id of the asset you want to copy.
 
       Example::
-        client.copy_asset("adeffee123342", id="7ee008c5-49a2-f8b5-997d-8b64de153c30")
+        client.assets.copy("adeffee123342", id="7ee008c5-49a2-f8b5-997d-8b64de153c30")
     """
     endpoint = '/assets/{}/copy'.format(destination_folder_id)
     return self.client._api_call('post', endpoint, kwargs)
@@ -118,7 +119,7 @@ def bulk_copy(self, destination_folder_id, asset_list=[], copy_comments=False):
       copy_comments (boolean): Whether or not to copy comments: True or False.
 
       Example::
-        client.bulk_copy_assets("adeffee123342", asset_list=["7ee008c5-49a2-f8b5-997d-8b64de153c30", \ 
+        client.assets.buly_copy("adeffee123342", asset_list=["7ee008c5-49a2-f8b5-997d-8b64de153c30", \ 
         "7ee008c5-49a2-f8b5-997d-8b64de153c30"], copy_comments=True)
     """
 
@@ -160,8 +161,14 @@ def _upload(self, asset, file):
     uploader = FrameioUploader(asset, file)
     uploader.upload()
 
-  def upload_folder(self, destination_id, folderpath):
-    pass
+  # def upload_folder(self, destination_id, folderpath):
+  #   try:
+  #     if os.path.isdir(folderpath):
+  #       # Good it's a directory, we can keep going
+
+  #   except OSError:
+  #     if not os.path.exists(folderpath):
+  #       sys.exit("Folder doesn't exist, exiting...")
 
   def build_asset_info(self, filepath):
     full_path = os.path.abspath(filepath)

frameioclient/service/comments.py

@@ -12,7 +12,7 @@ def create(self, asset_id, **kwargs):
 
       Example::
 
-        client.create_comment(
+        client.comments.create(
           asset_id="123abc",
           text="Hello world"
         )
@@ -51,7 +51,7 @@ def update(self, comment_id, **kwargs):
 
       Example::
 
-        client.create_comment(
+        client.comments.update(
           comment_id="123abc",
           text="Hello world"
         )
@@ -80,7 +80,7 @@ def reply(self, comment_id, **kwargs):
 
       Example::
 
-        client.reply_comment(
+        client.comments.reply(
           comment_id="123abc",
           text="Hello world"
         )

frameioclient/service/links.py

@@ -12,7 +12,7 @@ def create(self, project_id, **kwargs):
 
       Example::
 
-        client.create_review_link(
+        client.review_links.create(
           project_id="123",
           name="My Review Link",
           password="abc123"
@@ -50,7 +50,7 @@ def get_assets(self, link_id):
 
       Example::
 
-        client.get_review_link_items(
+        client.review_links.get_assets(
           link_id="123"
         )
     """
@@ -68,7 +68,7 @@ def update_assets(self, link_id, **kwargs):
 
       Example::
 
-        client.update_review_link_assets(
+        client.review_links.update_assets(
           link_id="123",
           asset_ids=["abc","def"]
         )
@@ -87,7 +87,7 @@ def update_settings(self, link_id, **kwargs):
 
       Example::
 
-        client.update_review_link(
+        client.review_links.update_settings(
           link_id,
           expires_at="2020-04-08T12:00:00+00:00",
           is_active=False,
@@ -111,7 +111,7 @@ def create(self, asset_id, **kwargs):
 
       Example::
 
-        client.create_presentation_link(
+        client.presentation_links.create(
           asset_id="9cee7966-4066-b326-7db1-f9e6f5e929e4",
           title="My fresh presentation",
           password="abc123"

frameioclient/service/logs.py

@@ -9,7 +9,7 @@ def list(self, account_id):
 
       Example::
 
-        client.get_audit_logs(
+        client.logs.list(
           account_id="6bdcb4d9-9a2e-a765-4548-ae6b27a6c024"
         )
     """

frameioclient/service/teams.py

@@ -4,7 +4,7 @@
 class Team(Service):
   def create(self, account_id, **kwargs):
     """
-    Create a Team.
+    Create a Team
 
     :Args:
       account_id (string): The account id you want to create this Team under.
@@ -13,7 +13,7 @@ def create(self, account_id, **kwargs):
 
       Example::
 
-        client.create_team(
+        client.teams.create(
           account_id="6bdcb4d9-4548-4548-4548-27a6c024ae6b",
           name="My Awesome Project",
         )
@@ -24,8 +24,8 @@ def create(self, account_id, **kwargs):
 
   def list(self, account_id, **kwargs):
     """
-    Get teams owned by the account. 
-    (To return all teams, use get_all_teams())
+    Get teams owned by the specified account. 
+    (To return all teams, use list_all())
     
     :Args:
       account_id (string): The account id.
@@ -45,30 +45,30 @@ def list_all(self, **kwargs):
 
   def get(self, team_id):
     """
-    Get's a team by id
+    Get team by id
 
     :Args:
-      team_id (string): the team's id
+      team_id (string): the Team's id
     """
     endpoint  = '/teams/{}'.format(team_id)
     return self.client._api_call('get', endpoint)
 
   def get_members(self, team_id):
     """
-    Get the member list for a given team_id.
+    Get the member list for a given Team.
 
     :Args:
-      team_id (string): The team id.
+      team_id (string): The Team id.
     """
     endpoint = '/teams/{}/members'.format(team_id)
     return self.client._api_call('get', endpoint)  
 
   def list_projects(self, team_id, **kwargs):
     """
-    Get projects owned by the team.
+    Get projects owned by the Team.
 
     :Args:
-      team_id (string): The team id.
+      team_id (string): The Team id.
     """
     endpoint = '/teams/{}/projects'.format(team_id)
     return self.client._api_call('get', endpoint, kwargs)