From 584dc5b3a608935e4ee8907b514e487d9d2c85df Mon Sep 17 00:00:00 2001 From: StevanFreeborn Date: Tue, 3 May 2022 13:54:31 -0500 Subject: [PATCH] update README.md --- README.md | 37 +++++++++++++++++++++++++++++++++++++ src/OnspringClient.py | 3 ++- 2 files changed, 39 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 7ea0c8d..e7984de 100644 --- a/README.md +++ b/README.md @@ -348,12 +348,49 @@ print(f'Message: {response.message}') #### Add Or Update List Value +To add a list value don't provide an id value. + ```python +from Models import ListItemRequest + +request = ListItemRequest( + listId=906, + name='Not Started', + id='', + numericValue=0, + color='#ffffff') + +response = client.AddOrUpdateListItem(request) + +print(f'Status Code: {response.statusCode}') +print(f'Id: {response.data.id}') +``` + +To update a list value provide an id value. + +```python +from Models import ListItemRequest + +request = ListItemRequest( + listId=906, + name='Pending', + id='4118d53a-9121-4345-8682-07f23d606daa', + numericValue=0, + color='#ffffff') + +response = client.AddOrUpdateListItem(request) + +print(f'Status Code: {response.statusCode}') +print(f'Id: {response.data.id}') ``` #### Delete List Value ```python +response = client.DeleteListItem(listId=906, itemId='36f94d8c-2b9d-465e-9ad1-ede04109efc9') + +print(f'Status Code: {response.statusCode}') +print(f'Message: {response.message}') ``` ### Records diff --git a/src/OnspringClient.py b/src/OnspringClient.py index 24650b5..a9621f3 100644 --- a/src/OnspringClient.py +++ b/src/OnspringClient.py @@ -1,3 +1,4 @@ +from uuid import UUID import requests import json import re @@ -853,7 +854,7 @@ class OnspringClient: response.status_code, raw=response) - def DeleteListItem(self, listId: int, itemId: uuid): + def DeleteListItem(self, listId: int, itemId: UUID): """ Delete a list value by its id and it's parent list id.