Stevan/onspring-api-sdk-python
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Continuing to build endpoints, methods, and models

Browse Source
This commit is contained in:
StevanFreeborn
2022-04-16 11:36:46 -05:00
parent 68bdbeb8fb
commit 889ae19609
3 changed files with 538 additions and 163 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Models.py
+60 -8
View File
@@ -1,23 +1,31 @@
import datetime
# generic
class ApiResponse:
def __init__(self, statusCode=None, data=None, message=None):
def __init__(self, statusCode=None, data=None, message=None, headers=None, responseText=None):
self.statusCode = statusCode
self.isSuccessful = int(statusCode) < 400
self.data = data
self.message = message
self.headers=None
self.responseText = responseText
class PagingRequest:
def __init__(self, pageNumber, pageSize):
def __init__(self, pageNumber: int, pageSize: int):
self.pageNumber = pageNumber
self.pageSize = pageSize
#app specific
class App:
def __init__(self, href, id, name):
def __init__(self, href: str, id: int, name: str):
self.href = href
self.id = id
self.name = name
class GetAppsResponse:
def __init__(self, pageNumber, pageSize, totalPages, totalRecords, apps: list[App]):
def __init__(self, pageNumber: int, pageSize: int, totalPages:int , totalRecords: int, apps: list[App]):
self.pageNumber = pageNumber
self.pageSize = pageSize
self.totalPages = totalPages
@@ -29,12 +37,14 @@ class GetAppByIdResponse:
self.app = app
class GetAppsByIdsResponse:
def __init__(self, count, apps: list[App]):
def __init__(self, count: int, apps: list[App]):
self.count = count
self.apps = apps
# field specific
class Field:
def __init__(self, id, appId, name, type, status, isRequired, isUnique):
def __init__(self, id: int, appId: int, name: str, type: str, status: str, isRequired: bool, isUnique: bool):
self.id = id
self.appId = appId
self.name = name
@@ -48,14 +58,56 @@ class GetFieldByIdResponse:
self.field = field
class GetFieldsByIdsResponse:
def __init__(self, count, fields: list[Field]):
def __init__(self, count: int, fields: list[Field]):
self.count = count
self.fields = fields
class GetFieldsByAppIdResponse:
def __init__(self, pageNumber, pageSize, totalPages, totalRecords, fields: list[Field]):
def __init__(self, pageNumber: int, pageSize: int, totalPages: int, totalRecords: int, fields: list[Field]):
self.pageNumber = pageNumber
self.pageSize = pageSize
self.totalPages = totalPages
self.totalRecords = totalRecords
self.fields = fields
# file specific
class File:
def __init__(self, name: str, contentType: str, contentLength: int, content: bytes):
self.name = name
self.contentType = contentType
self.contentLength = contentLength
self.content = content
class FileInfo:
def __init__(self, type: str, contentType: str, name: str, createdDate: str, modifiedDate: str, owner: str, fileHref: str):
self.type = type
self.contentType = contentType
self.name = name
self.createdDate = createdDate
self.modifiedDate = modifiedDate
self.owner = owner
self.fileHref = fileHref
class GetFileInfoByIdResponse:
def __init__(self, fileInfo: FileInfo):
self.fileInfo = fileInfo
class GetFileByIdResponse:
def __init__(self, file: File):
self.file = file
class SaveFileRequest:
def __init__(self, recordId: int, fieldId: int, fileName: str, filePath: str, contentType: str, notes: str=None, modifiedDate: datetime=None):
self.recordId = recordId
self.fieldId = fieldId
self.notes = notes
self.modifiedDate = modifiedDate
self.fileName = fileName
self.filePath = filePath
self.contentType = contentType
class SaveFileResponse:
def __init__(self, id: int):
self.id = id
OnspringClient.py
+365 -54
View File
@@ -1,10 +1,10 @@
import requests
import json
import re
from UrlHelper import *
from Models import *
class OnspringClient:
def __init__(self, url, key):
self.baseUrl = url
@@ -43,12 +43,18 @@ class OnspringClient:
if response.status_code == 400:
return ApiResponse(
response.status_code,
message='Invalid paging information')
message='Invalid paging information',
headers=response.headers,
responseText=response.text)
if response.status_code == 401:
return ApiResponse(
response.status_code,
message='Unauthorized request')
message='Unauthorized request',
headers=response.headers,
responseText=response.text)
if response.status_code == 200:
responseJson = response.json()
@@ -71,7 +77,14 @@ class OnspringClient:
return ApiResponse(
response.status_code,
data)
data,
headers=response.headers,
responseText=response.text)
return ApiResponse(
response.status_code,
headers=response.headers,
responseText=response.text)
def GetAppById(self, appId: int):
@@ -85,20 +98,25 @@ class OnspringClient:
if response.status_code == 401:
return ApiResponse(
response.status_code,
message='Unauthorized request'
)
message='Unauthorized request',
headers=response.headers,
responseText=response.text)
if response.status_code == 403:
return ApiResponse(
response.status_code,
message='Client does not have read access to the app'
)
message='Client does not have read access to the app',
headers=response.headers,
responseText=response.text)
if response.status_code == 404:
return ApiResponse(
response.status_code,
message='App could not be found'
)
message='App could not be found',
headers=response.headers,
responseText=response.text)
if response.status_code == 200:
responseJson = response.json()
@@ -111,8 +129,14 @@ class OnspringClient:
return ApiResponse(
response.status_code,
data
)
data,
headers=response.headers,
responseText=response.text)
return ApiResponse(
response.status_code,
headers=response.headers,
responseText=response.text)
def GetAppByIds(self, appIds: list):
@@ -137,14 +161,18 @@ class OnspringClient:
if response.status_code == 401:
return ApiResponse(
response.status_code,
message='Unauthorized request'
)
message='Unauthorized request',
headers=response.headers,
responseText=response.text)
if response.status_code == 403:
return ApiResponse(
response.status_code,
message='Client does not have read access to the app'
)
message='Client does not have read access to the app',
headers=response.headers,
responseText=response.text)
if response.status_code == 200:
responseJson = response.json()
@@ -160,13 +188,18 @@ class OnspringClient:
data = GetAppsByIdsResponse(
responseJson['count'],
apps
)
apps)
return ApiResponse(
response.status_code,
data
)
data,
headers=response.headers,
responseText=response.text)
return ApiResponse(
response.status_code,
headers=response.headers,
responseText=response.text)
# field methods
@@ -182,20 +215,25 @@ class OnspringClient:
if response.status_code == 401:
return ApiResponse(
response.status_code,
message='Unauthorized request'
)
message='Unauthorized request',
headers=response.headers,
responseText=response.text)
if response.status_code == 403:
return ApiResponse(
response.status_code,
message='Client does not have read access to the field'
)
message='Client does not have read access to the field',
headers=response.headers,
responseText=response.text)
if response.status_code == 404:
return ApiResponse(
response.status_code,
message='Field could not be found'
)
message='Field could not be found',
headers=response.headers,
responseText=response.text)
if response.status_code == 200:
jsonResponse = response.json()
@@ -206,15 +244,20 @@ class OnspringClient:
jsonResponse['type'],
jsonResponse['status'],
jsonResponse['isRequired'],
jsonResponse['isUnique'],
)
jsonResponse['isUnique'],)
data = GetFieldByIdResponse(field)
return ApiResponse(
response.status_code,
data
)
data,
headers=response.headers,
responseText=response.text)
return ApiResponse(
response.status_code,
headers=response.headers,
responseText=response.text)
def GetFieldsByIds(self, fieldIds: list):
@@ -239,20 +282,25 @@ class OnspringClient:
if response.status_code == 401:
return ApiResponse(
response.status_code,
message='Unauthorized request'
)
message='Unauthorized request',
headers=response.headers,
responseText=response.text)
if response.status_code == 403:
return ApiResponse(
response.status_code,
message='Client does not have read access to the field(s)'
)
message='Client does not have read access to the field(s)',
headers=response.headers,
responseText=response.text)
if response.status_code == 404:
return ApiResponse(
response.status_code,
message='Field(s) could not be found'
)
message='Field(s) could not be found',
headers=response.headers,
responseText=response.text)
if response.status_code == 200:
responseJson = response.json()
@@ -272,13 +320,18 @@ class OnspringClient:
data = GetFieldsByIdsResponse(
responseJson['count'],
fields
)
fields)
return ApiResponse(
response.status_code,
data
)
data,
headers=response.headers,
responseText=response.text)
return ApiResponse(
response.status_code,
headers=response.headers,
responseText=response.text)
def GetFieldsByAppId(self, appId: int, pagingRequest=PagingRequest(1, 50)):
@@ -295,12 +348,18 @@ class OnspringClient:
if response.status_code == 400:
return ApiResponse(
response.status_code,
message='Invalid paging information')
message='Invalid paging information',
headers=response.headers,
responseText=response.text)
if response.status_code == 401:
return ApiResponse(
response.status_code,
message='Unauthorized request')
message='Unauthorized request',
headers=response.headers,
responseText=response.text)
if response.status_code == 200:
responseJson = response.json()
@@ -327,21 +386,273 @@ class OnspringClient:
return ApiResponse(
response.status_code,
data)
data,
headers=response.headers,
responseText=response.text)
return ApiResponse(
response.status_code,
headers=response.headers,
responseText=response.text)
# file methods
def GetFileInfoById(self, recordId: int, fieldId: int, fileId: int):
endpoint = GetFileInfoByIdEndpoint(
self.baseUrl,
recordId,
fieldId,
fileId)
response = requests.request(
'GET',
endpoint,
headers=self.headers,)
if response.status_code == 400:
return ApiResponse(
response.status_code,
message='Request is invalid based on underlying data',
headers=response.headers,
responseText=response.text)
if response.status_code == 401:
return ApiResponse(
response.status_code,
message='Unauthorized request',
headers=response.headers,
responseText=response.text)
if response.status_code == 403:
return ApiResponse(
response.status_code,
message='Client does not have read access to the file',
headers=response.headers,
responseText=response.text)
if response.status_code == 404:
return ApiResponse(
response.status_code,
message='File could not be found',
headers=response.headers,
responseText=response.text)
if response.status_code == 200:
jsonResponse = response.json()
fileInfo = FileInfo(
jsonResponse["type"],
jsonResponse["contentType"],
jsonResponse["name"],
jsonResponse["createdDate"],
jsonResponse["modifiedDate"],
jsonResponse["owner"],
jsonResponse["fileHref"])
data = GetFileInfoByIdResponse(fileInfo)
return ApiResponse(
response.status_code,
data,
headers=response.headers,
responseText=response.text)
return ApiResponse(
response.status_code,
headers=response.headers,
responseText=response.text)
def DeleteFileById(self, recordId: int, fieldId: int, fileId: int):
endpoint = DeleteFileByIdEndpoint(
self.baseUrl,
recordId,
fieldId,
fileId)
response = requests.request(
'DELETE',
endpoint,
headers=self.headers,)
if response.status_code == 400:
return ApiResponse(
response.status_code,
message='Request is invalid based on underlying data',
headers=response.headers,
responseText=response.text)
if response.status_code == 401:
return ApiResponse(
response.status_code,
message='Unauthorized request',
headers=response.headers,
responseText=response.text)
if response.status_code == 403 or response.status_code == 404:
jsonResponse = response.json()
return ApiResponse(
response.status_code,
message=jsonResponse["message"],
headers=response.headers,
responseText=response.text)
if response.status_code == 500:
return ApiResponse(
response.status_code,
message='File could not be deleted due to internal error',
headers=response.headers,
responseText=response.text)
if response.status_code == 204:
return ApiResponse(
response.status_code,
message="File deleted successfully",
headers=response.headers,
responseText=response.text)
return ApiResponse(
response.status_code,
headers=response.headers,
responseText=response.text)
def GetFileById(self, recordId: int, fieldId: int, fileId: int):
endpoint = GetFileByIdEndpoint(
self.baseUrl,
recordId,
fieldId,
fileId)
response = requests.request(
'GET',
endpoint,
headers=self.headers,)
if response.status_code == 400:
return ApiResponse(
response.status_code,
message='Request is invalid based on underlying data',
headers=response.headers,
responseText=response.text)
if response.status_code == 401:
return ApiResponse(
response.status_code,
message='Unauthorized request',
headers=response.headers,
responseText=response.text)
if response.status_code == 403 or response.status_code == 404:
jsonResponse = response.json()
return ApiResponse(
response.status_code,
message=jsonResponse["message"],
headers=response.headers,
responseText=response.text)
if response.status_code == 200:
fileName = response.headers["Content-Disposition"]
result = re.search("filename=.*;", fileName).group()
if result:
fileName = re.sub("filename=|\"|;", "", result)
else:
fileName = None
file = File(
fileName,
response.headers["Content-Type"],
response.headers["Content-Length"],
response.content)
data = GetFileByIdResponse(file)
return ApiResponse(
response.status_code,
data,
headers=response.headers,
responseText=response.text)
return ApiResponse(
response.status_code,
headers=response.headers,
responseText=response.text)
def SaveFile(self, saveFileRequest: SaveFileRequest):
endpoint = SaveFileEndpoint(self.baseUrl)
requestData = {
"recordId": saveFileRequest.recordId,
"fieldId": saveFileRequest.fieldId,
"notes": saveFileRequest.notes,
"modifiedDate": saveFileRequest.modifiedDate
}
files = [
(
'File',
(saveFileRequest.fileName, open(saveFileRequest.filePath,'rb'),saveFileRequest.contentType)
)
]
response = requests.request(
"POST",
endpoint,
headers=self.headers,
data=requestData,
files=files)
if response.status_code == 400:
return ApiResponse(
response.status_code,
message='Request is invalid based on underlying data',
headers=response.headers,
responseText=response.text)
if response.status_code == 401:
return ApiResponse(
response.status_code,
message='Unauthorized request',
headers=response.headers,
responseText=response.text)
if response.status_code in [403,404,500]:
jsonResponse = response.json()
return ApiResponse(
response.status_code,
message=jsonResponse["message"],
headers=response.headers,
responseText=response.text)
if response.status_code == 201:
responseJson = response.json()
data = SaveFileResponse(responseJson["id"])
return ApiResponse(
response.status_code,
data,
headers=response.headers,
responseText=response.text)
return ApiResponse(
response.status_code,
headers=response.headers,
responseText=response.text)
# list methods
# record methods
# report methods
url = 'https://api.onspring.com'
apiKey = '61642d8c686f9e8747e42af8/52cae9a9-4c49-48b6-a3fe-10a48d46ac69'
onspringClient = OnspringClient(url, apiKey)
response = onspringClient.GetFieldsByAppId(8)
print(response.data.fields[0].name)
UrlHelper.py
+12
View File
@@ -27,6 +27,18 @@ def GetFieldsByAppIdEndpoint(baseUrl, appId):
# file endpoints
def GetFileInfoByIdEndpoint(baseUrl, recordId, fieldId, fileId):
return f'{baseUrl}/Files/recordId/{recordId}/fieldId/{fieldId}/fileId/{fileId}'
def DeleteFileByIdEndpoint(baseUrl, recordId, fieldId, fileId):
return f'{baseUrl}/Files/recordId/{recordId}/fieldId/{fieldId}/fileId/{fileId}'
def GetFileByIdEndpoint(baseUrl, recordId, fieldId, fileId):
return f'{baseUrl}/Files/recordId/{recordId}/fieldId/{fieldId}/fileId/{fileId}/file'
def SaveFileEndpoint(baseUrl):
return f'{baseUrl}/Files'
# list endpoints
# record endpoints