Skip to content

Commit

Permalink
refactor: unify naming of ids and add missing typing
Browse files Browse the repository at this point in the history
  • Loading branch information
bara-m committed Feb 6, 2024
1 parent 92a5e95 commit 57a42d6
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 16 deletions.
10 changes: 5 additions & 5 deletions rossum_api/elis_api_client.py
Original file line number Diff line number Diff line change
Expand Up @@ -192,7 +192,7 @@ async def create_new_schema(self, data: Dict[str, Any]) -> Schema:

return self._deserializer(Resource.Schema, schema)

async def delete_schema(self, schema_id) -> None:
async def delete_schema(self, schema_id: int) -> None:
"""https://elis.rossum.ai/api/docs/#delete-a-schema."""
return await self._http_client.delete(Resource.Schema, schema_id)

Expand Down Expand Up @@ -397,7 +397,7 @@ async def list_all_workspaces(
async for w in self._http_client.fetch_all(Resource.Workspace, ordering, **filters):
yield self._deserializer(Resource.Workspace, w)

async def retrieve_workspace(self, workspace_id) -> Workspace:
async def retrieve_workspace(self, workspace_id: int) -> Workspace:
"""https://elis.rossum.ai/api/docs/#retrieve-a-workspace."""
workspace = await self._http_client.fetch_one(Resource.Workspace, workspace_id)

Expand All @@ -409,7 +409,7 @@ async def create_new_workspace(self, data: Dict[str, Any]) -> Workspace:

return self._deserializer(Resource.Workspace, workspace)

async def delete_workspace(self, workspace_id) -> None:
async def delete_workspace(self, workspace_id: int) -> None:
"""https://elis.rossum.ai/api/docs/#delete-a-workspace."""
return await self._http_client.delete(Resource.Workspace, workspace_id)

Expand All @@ -430,7 +430,7 @@ async def list_all_connectors(
async for c in self._http_client.fetch_all(Resource.Connector, ordering, **filters):
yield self._deserializer(Resource.Connector, c)

async def retrieve_connector(self, connector_id) -> Connector:
async def retrieve_connector(self, connector_id: int) -> Connector:
"""https://elis.rossum.ai/api/docs/#retrieve-a-connector."""
connector = await self._http_client.fetch_one(Resource.Connector, connector_id)

Expand All @@ -452,7 +452,7 @@ async def list_all_hooks(
async for h in self._http_client.fetch_all(Resource.Hook, ordering, **filters):
yield self._deserializer(Resource.Hook, h)

async def retrieve_hook(self, hook_id) -> Hook:
async def retrieve_hook(self, hook_id: int) -> Hook:
"""https://elis.rossum.ai/api/docs/#retrieve-a-hook."""
hook = await self._http_client.fetch_one(Resource.Hook, hook_id)

Expand Down
28 changes: 17 additions & 11 deletions rossum_api/elis_api_client_sync.py
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ def create_new_queue(
"""https://elis.rossum.ai/api/docs/#create-new-queue."""
return self.event_loop.run_until_complete(self.elis_api_client.create_new_queue(data))

def delete_queue(self, queue_id) -> None:
def delete_queue(self, queue_id: int) -> None:
"""https://elis.rossum.ai/api/docs/#delete-a-queue."""
return self.event_loop.run_until_complete(self.elis_api_client.delete_queue(queue_id))

Expand Down Expand Up @@ -191,9 +191,9 @@ def create_new_schema(self, data: Dict[str, Any]) -> Schema:
"""https://elis.rossum.ai/api/docs/#create-a-new-schema."""
return self.event_loop.run_until_complete(self.elis_api_client.create_new_schema(data))

def delete_schema(self, id) -> None:
def delete_schema(self, schema_id: int) -> None:
"""https://elis.rossum.ai/api/docs/#delete-a-schema."""
return self.event_loop.run_until_complete(self.elis_api_client.delete_schema(id))
return self.event_loop.run_until_complete(self.elis_api_client.delete_schema(schema_id))

# ##### USERS #####
def list_all_users(
Expand Down Expand Up @@ -347,17 +347,21 @@ def list_all_workspaces(
"""https://elis.rossum.ai/api/docs/#list-all-workspaces."""
return self._iter_over_async(self.elis_api_client.list_all_workspaces(ordering, **filters))

def retrieve_workspace(self, id) -> Workspace:
def retrieve_workspace(self, workspace_id: int) -> Workspace:
"""https://elis.rossum.ai/api/docs/#retrieve-a-workspace."""
return self.event_loop.run_until_complete(self.elis_api_client.retrieve_workspace(id))
return self.event_loop.run_until_complete(
self.elis_api_client.retrieve_workspace(workspace_id)
)

def create_new_workspace(self, data: Dict[str, Any]) -> Workspace:
"""https://elis.rossum.ai/api/docs/#create-a-new-workspace."""
return self.event_loop.run_until_complete(self.elis_api_client.create_new_workspace(data))

def delete_workspace(self, id) -> None:
def delete_workspace(self, workspace_id: int) -> None:
"""https://elis.rossum.ai/api/docs/#retrieve-a-workspace."""
return self.event_loop.run_until_complete(self.elis_api_client.delete_workspace(id))
return self.event_loop.run_until_complete(
self.elis_api_client.delete_workspace(workspace_id)
)

# ##### INBOX #####
def create_new_inbox(
Expand All @@ -376,9 +380,11 @@ def list_all_connectors(
"""https://elis.rossum.ai/api/docs/#list-all-connectors."""
return self._iter_over_async(self.elis_api_client.list_all_connectors(ordering, **filters))

def retrieve_connector(self, id) -> Connector:
def retrieve_connector(self, connector_id: int) -> Connector:
"""https://elis.rossum.ai/api/docs/#retrieve-a-connector."""
return self.event_loop.run_until_complete(self.elis_api_client.retrieve_connector(id))
return self.event_loop.run_until_complete(
self.elis_api_client.retrieve_connector(connector_id)
)

def create_new_connector(self, data: Dict[str, Any]) -> Connector:
"""https://elis.rossum.ai/api/docs/#create-a-new-connector."""
Expand All @@ -393,9 +399,9 @@ def list_all_hooks(
"""https://elis.rossum.ai/api/docs/#list-all-hooks."""
return self._iter_over_async(self.elis_api_client.list_all_hooks(ordering, **filters))

def retrieve_hook(self, id) -> Hook:
def retrieve_hook(self, hook_id: int) -> Hook:
"""https://elis.rossum.ai/api/docs/#retrieve-a-hook."""
return self.event_loop.run_until_complete(self.elis_api_client.retrieve_hook(id))
return self.event_loop.run_until_complete(self.elis_api_client.retrieve_hook(hook_id))

def create_new_hook(self, data: Dict[str, Any]) -> Hook:
"""https://elis.rossum.ai/api/docs/#create-a-new-hook."""
Expand Down

0 comments on commit 57a42d6

Please sign in to comment.