Merge pull request #9 from StevanFreeborn/stevanfreeborn/feat/update-python-examples-for-version-3

feat: update python code snippets to reflect new version 3 of the python sdk
This commit is contained in:
Stevan Freeborn
2026-06-26 17:52:17 -05:00
committed by GitHub
24 changed files with 1884 additions and 7790 deletions
+1707 -7637
View File
File diff suppressed because it is too large Load Diff
+4 -4
View File
@@ -32,10 +32,10 @@
"@types/prismjs": "^1.26.6",
"cross-env": "^10.1.0",
"eslint-config-prettier": "^10.1.8",
"eslint-plugin-prettier": "^5.5.5",
"jest": "^30.3.0",
"jest-environment-jsdom": "^30.3.0",
"prettier": "^3.8.1",
"eslint-plugin-prettier": "^5.5.6",
"jest": "^30.4.2",
"jest-environment-jsdom": "^30.4.1",
"prettier": "^3.8.5",
"ts-node": "^10.9.2"
}
}
@@ -37,7 +37,7 @@ console.log(app);
```
```python
from OnspringApiSdk.OnspringClient import OnspringClient
from onspring_api_sdk import OnspringClient
from configparser import ConfigParser
cfg = ConfigParser()
@@ -48,12 +48,13 @@ url = cfg['prod']['url']
client = OnspringClient(url, key)
response = client.GetAppById(appId=195)
response = client.get_app_by_id(app_id=195)
print(f'Status Code: {response.statusCode}')
print(f'Status Code: {response.status_code}')
print(f'id: {response.data.app.id}')
print(f'Name: {response.data.app.name}')
print(f'href: {response.data.app.href}')
```
```rust
@@ -42,7 +42,7 @@ for (const app of apps) {
```
```python
from OnspringApiSdk.OnspringClient import OnspringClient
from onspring_api_sdk import OnspringClient
from configparser import ConfigParser
cfg = ConfigParser()
@@ -52,18 +52,19 @@ key = cfg['prod']['key']
url = cfg['prod']['url']
client = OnspringClient(url, key)
response = client.GetApps()
response = client.get_apps()
print(f'Status Code: {response.statusCode}')
print(f'Page Size: {response.data.pageSize}')
print(f'Page Number: {response.data.pageNumber}')
print(f'Total Pages: {response.data.totalPages}')
print(f'Total Records: {response.data.totalRecords}')
print(f'Status Code: {response.status_code}')
print(f'Page Size: {response.data.page_size}')
print(f'Page Number: {response.data.page_number}')
print(f'Total Pages: {response.data.total_pages}')
print(f'Total Records: {response.data.total_records}')
for app in response.data.apps:
print(f'Id: {app.id}')
print(f'Name: {app.name}')
print(f'href: {app.href}')
```
```rust
@@ -46,7 +46,7 @@ for (const app of apps) {
```
```python
from OnspringApiSdk.OnspringClient import OnspringClient
from onspring_api_sdk import OnspringClient
from configparser import ConfigParser
cfg = ConfigParser()
@@ -56,15 +56,16 @@ key = cfg['prod']['key']
url = cfg['prod']['url']
client = OnspringClient(url, key)
response = client.GetAppsByIds(appIds=[195, 240])
response = client.get_apps_by_ids(app_ids=[195, 240])
print(f'Status Code: {response.statusCode}')
print(f'Status Code: {response.status_code}')
print(f'Count: {response.data.count}')
for app in response.data.apps:
print(f'Id: {app.id}')
print(f'Name: {app.name}')
print(f'href: {app.href}')
```
```rust
@@ -37,7 +37,7 @@ console.log(res);
```
```python
from OnspringApiSdk.OnspringClient import OnspringClient
from onspring_api_sdk import OnspringClient
from configparser import ConfigParser
cfg = ConfigParser()
@@ -48,12 +48,13 @@ url = cfg['prod']['url']
client = OnspringClient(url, key)
canConnect = client.CanConnect()
canConnect = client.can_connect()
if canConnect:
if can_connect:
print('Connected successfully')
else:
print('Attempt to connect failed')
```
```rust
@@ -38,7 +38,7 @@ console.log(field);
```
```python
from OnspringApiSdk.OnspringClient import OnspringClient
from onspring_api_sdk import OnspringClient
from configparser import ConfigParser
cfg = ConfigParser()
@@ -48,10 +48,11 @@ key = cfg['prod']['key']
url = cfg['prod']['url']
client = OnspringClient(url, key)
response = client.GetFieldById(fieldId=6986)
response = client.get_field_by_id(field_id=6986)
print(f'Status Code: {response.status_code}')
print(f'Field Id: {response.data.field.id}')
print(f'Status Code: {response.statusCode}')
print(f'Field Id: {response.data.id}')
```
```rust
@@ -42,7 +42,7 @@ for (const field of fields) {
```
```python
from OnspringApiSdk.OnspringClient import OnspringClient
from onspring_api_sdk import OnspringClient
from configparser import ConfigParser
cfg = ConfigParser()
@@ -52,16 +52,17 @@ key = cfg['prod']['key']
url = cfg['prod']['url']
client = OnspringClient(url, key)
response = client.GetFieldsByAppId(appId=195)
response = client.get_fields_by_app_id(app_id=195)
print(f'Status Code: {response.statusCode}')
print(f'Page Size: {response.data.pageSize}')
print(f'Page Number: {response.data.pageNumber}')
print(f'Total Pages: {response.data.totalPages}')
print(f'Total Records: {response.data.totalRecords}')
print(f'Status Code: {response.status_code}')
print(f'Page Size: {response.data.page_size}')
print(f'Page Number: {response.data.page_number}')
print(f'Total Pages: {response.data.total_pages}')
print(f'Total Records: {response.data.total_records}')
for field in response.data.fields:
print(f'Field Id: {field.id}')
```
```rust
@@ -44,7 +44,7 @@ for (const field of fields) {
```
```python
from OnspringApiSdk.OnspringClient import OnspringClient
from onspring_api_sdk import OnspringClient
from configparser import ConfigParser
cfg = ConfigParser()
@@ -54,13 +54,14 @@ key = cfg['prod']['key']
url = cfg['prod']['url']
client = OnspringClient(url, key)
response = client.GetFieldsByIds(fieldIds=[6983, 6986, 6987, 6985, 6984])
response = client.get_fields_by_ids(field_ids=[6983, 6986, 6987, 6985, 6984])
print(f'Status Code: {response.statusCode}')
print(f'Status Code: {response.status_code}')
print(f'Count: {response.data.count}')
for field in response.data.fields:
print(f'Field Id: {field.id}')
```
```rust
@@ -69,8 +69,8 @@ console.log(fileId);
```
```python
from OnspringApiSdk.OnspringClient import OnspringClient
from OnspringApiSdk.Models import SaveFileRequest
from onspring_api_sdk import OnspringClient
from onspring_api_sdk.models import SaveFileRequest
from configparser import ConfigParser
cfg = ConfigParser()
@@ -81,19 +81,20 @@ url = cfg['prod']['url']
client = OnspringClient(url, key)
request = SaveFileRequest(
recordId=140,
fieldId=6989,
fileName='test-attachment.txt',
filePath='test-attachment.txt',
contentType='text/plain',
record_id=140,
field_id=6989,
file_name='test-attachment.txt',
file_path='test-attachment.txt',
content_type='text/plain',
notes='Updating record with attachment.',
modifiedDate=datetime.now()
modified_date=datetime.now()
)
response = client.SaveFile(request)
response = client.save_file(request)
print(f'Status Code: {response.statusCode}')
print(f'Status Code: {response.status_code}')
print(f'File Id: {response.data.id}')
```
```rust
@@ -42,7 +42,7 @@ res.statusCode === 204
```
```python
from OnspringApiSdk.OnspringClient import OnspringClient
from onspring_api_sdk import OnspringClient
from configparser import ConfigParser
cfg = ConfigParser()
@@ -52,12 +52,13 @@ key = cfg['prod']['key']
url = cfg['prod']['url']
client = OnspringClient(url, key)
response = client.DeleteFileById(recordId=140, fieldId=6989, fileId=1904)
response = client.delete_file_by_id(record_id=140, field_id=6989, fileId=1904)
if response.status_code == 204:
print('File deleted')
else:
print('Error deleting file')
```
```rust
@@ -51,7 +51,7 @@ file.stream.pipe(fs.createWriteStream(file.fileName));
```
```python
from OnspringApiSdk.OnspringClient import OnspringClient
from onspring_api_sdk import OnspringClient
from configparser import ConfigParser
cfg = ConfigParser()
@@ -61,19 +61,20 @@ key = cfg['prod']['key']
url = cfg['prod']['url']
client = OnspringClient(url, key)
response = client.GetFileById(recordId=1, fieldId=6989, fileId=89)
response = client.get_file_by_id(record_id=1, field_id=6989, fileId=89)
print(f'Status Code: {response.statusCode}')
print(f'Status Code: {response.status_code}')
print(f'Name: {response.data.file.name}')
print(f'Content Type: {response.data.file.contentType}')
print(f'Content Length: {response.data.file.contentLength}')
print(f'Content Type: {response.data.file.content_type}')
print(f'Content Length: {response.data.file.content_length}')
filePath = f'C:\\Users\\sfree\\Documents\\Temp\\{response.data.file.name}'
file_path = f'C:\\Users\\sfree\\Documents\\Temp\\{response.data.file.name}'
with open(filePath, "wb") as file:
with open(file_path, "wb") as file:
file.write(response.data.file.content)
print(f'File Location: {filePath}')
print(f'File Location: {file_path}')
```
```rust
@@ -37,7 +37,7 @@ console.log(fileInfo);
```
```python
from OnspringApiSdk.OnspringClient import OnspringClient
from onspring_api_sdk import OnspringClient
from configparser import ConfigParser
cfg = ConfigParser()
@@ -47,10 +47,11 @@ key = cfg['prod']['key']
url = cfg['prod']['url']
client = OnspringClient(url, key)
response = client.GetFileInfoById(recordId=1, fieldId=6989, fileId=89)
response = client.get_file_info_by_id(record_id=1, field_id=6989, fileId=89)
print(f'Name: {response.data.file_info.name}')
print(f'Content Type: {response.data.fileInfo.content_type}')
print(f'Name: {response.data.fileInfo.name}')
print(f'Content Type: {response.data.fileInfo.contentType}')
```
```rust
@@ -48,7 +48,7 @@ res.statusCode === 204
```
```python
from OnspringApiSdk.OnspringClient import OnspringClient
from onspring_api_sdk import OnspringClient
from configparser import ConfigParser
cfg = ConfigParser()
@@ -58,13 +58,14 @@ key = cfg['prod']['key']
url = cfg['prod']['url']
client = OnspringClient(url, key)
response = client.DeleteListItem(
listId=906,
response = client.delete_list_item(
list_id=906,
itemId='36f94d8c-2b9d-465e-9ad1-ede04109efc9'
)
print(f'Status Code: {response.statusCode}')
print(f'Status Code: {response.status_code}')
print(f'Message: {response.message}')
```
```rust
@@ -64,8 +64,8 @@ console.log(itemId);
```
```python
from OnspringApiSdk.OnspringClient import OnspringClient
from OnspringApiSdk.Models import ListItemRequest
from onspring_api_sdk import OnspringClient
from onspring_api_sdk.models import ListItemRequest
from configparser import ConfigParser
cfg = ConfigParser()
@@ -76,17 +76,18 @@ url = cfg['prod']['url']
client = OnspringClient(url, key)
request = ListItemRequest(
listId=906,
list_id=906,
name='Not Started',
id=None,
numericValue=0,
numeric_value=0,
color='#ffffff'
)
response = client.AddOrUpdateListItem(request)
response = client.add_or_update_list_item(request)
print(f'Status Code: {response.statusCode}')
print(f'Status Code: {response.status_code}')
print(f'Id: {response.data.id}')
```
```rust
@@ -42,7 +42,7 @@ res.statusCode === 204
```
```python
from OnspringApiSdk.OnspringClient import OnspringClient
from onspring_api_sdk import OnspringClient
from configparser import ConfigParser
cfg = ConfigParser()
@@ -52,10 +52,11 @@ key = cfg['prod']['key']
url = cfg['prod']['url']
client = OnspringClient(url, key)
response = client.DeleteRecordById(appId=195, recordId=140)
response = client.delete_record_by_id(app_id=195, recordId=140)
print(f'Status Code: {response.statusCode}')
print(f'Status Code: {response.status_code}')
print(f'Message: {response.message}')
```
```rust
@@ -55,8 +55,8 @@ res.statusCode === 204
```
```python
from OnspringApiSdk.OnspringClient import OnspringClient
from OnspringApiSdk.Models import DeleteBatchRecordsRequest
from onspring_api_sdk import OnspringClient
from onspring_api_sdk.models import DeleteBatchRecordsRequest
from configparser import ConfigParser
cfg = ConfigParser()
@@ -66,11 +66,12 @@ key = cfg['prod']['key']
url = cfg['prod']['url']
client = OnspringClient(url, key)
request = DeleteBatchRecordsRequest(appId=195, recordIds=[138, 139])
response = client.DeleteRecordsByIds(request)
request = DeleteBatchRecordsRequest(app_id=195, record_ids=[138, 139])
response = client.delete_records_by_ids(request)
print(f'Status Code: {response.statusCode}')
print(f'Status Code: {response.status_code}')
print(f'Message: {response.message}')
```
```rust
@@ -52,22 +52,23 @@ console.log(record);
```
```python
from OnspringApiSdk.OnspringClient import OnspringClient
from OnspringApiSdk.Models import GetRecordByIdRequest
from onspring_api_sdk import OnspringClient
from onspring_api_sdk.models import GetRecordByIdRequest
from configparser import ConfigParser
request = GetRecordByIdRequest(appId=195, recordId=1)
response = client.GetRecordById(request)
response = client.get_record_by_id(request)
print(f'Status Code: {response.statusCode}')
print(f'AppId: {response.data.appId}')
print(f'RecordId: {response.data.recordId}')
print(f'Status Code: {response.status_code}')
print(f'AppId: {response.data.app_id}')
print(f'RecordId: {response.data.record_id}')
for field in response.data.fields:
print(f'Type: {field.type}')
print(f'FieldId: {field.fieldId}')
print(f'Value: {field.GetResultValueString()}')
print(f'FieldId: {field.field_id}')
print(f'Value: {field.value}')
```
```rust
@@ -41,8 +41,8 @@ for (const app of apps) {
```
```python
from OnspringApiSdk.OnspringClient import OnspringClient
from OnspringApiSdk.Models import GetRecordsByAppRequest
from onspring_api_sdk import OnspringClient
from onspring_api_sdk.models import GetRecordsByAppRequest
from configparser import ConfigParser
cfg = ConfigParser()
@@ -53,22 +53,23 @@ url = cfg['prod']['url']
client = OnspringClient(url, key)
request = GetRecordsByAppRequest(appId=195)
response = client.GetRecordsByAppId(request)
response = client.get_records_by_app_id(request)
print(f'Status Code: {response.statusCode}')
print(f'Page Size: {response.data.pageSize}')
print(f'Page Number: {response.data.pageNumber}')
print(f'Total Pages: {response.data.totalPages}')
print(f'Total Records: {response.data.totalRecords}')
print(f'Status Code: {response.status_code}')
print(f'Page Size: {response.data.page_size}')
print(f'Page Number: {response.data.page_number}')
print(f'Total Pages: {response.data.total_pages}')
print(f'Total Records: {response.data.total_records}')
for record in response.data.records:
print(f'AppId: {record.appId}')
print(f'RecordId: {record.recordId}')
print(f'AppId: {record.app_id}')
print(f'RecordId: {record.record_id}')
for field in record.fields:
print(f'Type: {field.type}')
print(f'FieldId: {field.fieldId}')
print(f'Value: {field.GetResultValueString()}')
print(f'FieldId: {field.field_id}')
print(f'Value: {field.value}')
```
```rust
@@ -68,8 +68,8 @@ for (const record of records) {
```
```python
from OnspringApiSdk.OnspringClient import OnspringClient
from OnspringApiSdk.Models import GetBatchRecordsRequest
from onspring_api_sdk import OnspringClient
from onspring_api_sdk.models import GetBatchRecordsRequest
from configparser import ConfigParser
cfg = ConfigParser()
@@ -80,24 +80,25 @@ url = cfg['prod']['url']
client = OnspringClient(url, key)
request = GetBatchRecordsRequest(
appId=195,
recordIds=[1],
fieldIds=[6983, 6986, 6987, 6985, 6984],
dataFormat='Raw'
app_id=195,
record_ids=[1],
field_ids=[6983, 6986, 6987, 6985, 6984],
data_format='Raw'
)
response = client.GetRecordsByIds(request)
response = client.get_records_by_ids(request)
print(f'Status Code: {response.statusCode}')
print(f'Status Code: {response.status_code}')
print(f'Count: {response.data.count}')
for record in response.data.records:
print(f'AppId: {record.appId}')
print(f'RecordId: {record.recordId}')
print(f'AppId: {record.app_id}')
print(f'RecordId: {record.record_id}')
for field in record.fields:
print(f'Type: {field.type}')
print(f'FieldId: {field.fieldId}')
print(f'Value: {field.GetResultValueString()}')
print(f'FieldId: {field.field_id}')
print(f'Value: {field.value}')
```
```rust
@@ -84,9 +84,9 @@ for (const record of records) {
```
```python
from OnspringApiSdk.OnspringClient import OnspringClient
from OnspringApiSdk.Models import QueryRecordsRequest
from OnspringApiSdk.Enums import DataFormat
from onspring_api_sdk import OnspringClient
from onspring_api_sdk.models import QueryRecordsRequest
from onspring_api_sdk.enums import DataFormat
from configparser import ConfigParser
cfg = ConfigParser()
@@ -102,28 +102,29 @@ operator = 'eq'
value = '\'Test Task 5\''
request = QueryRecordsRequest(
appId=195,
app_id=195,
filter=f'{fieldId} {operator} {value}',
fieldIds=[6983, 6986, 6987, 6985, 6984],
dataFormat=DataFormat.Formatted.name,
field_ids=[6983, 6986, 6987, 6985, 6984],
data_format=DataFormat.Formatted.name,
)
response = client.QueryRecords(request)
response = client.query_records(request)
print(f'Status Code: {response.statusCode}')
print(f'Page Size: {response.data.pageSize}')
print(f'Page Number: {response.data.pageNumber}')
print(f'Total Pages: {response.data.totalPages}')
print(f'Total Records: {response.data.totalRecords}')
print(f'Status Code: {response.status_code}')
print(f'Page Size: {response.data.page_size}')
print(f'Page Number: {response.data.page_number}')
print(f'Total Pages: {response.data.total_pages}')
print(f'Total Records: {response.data.total_records}')
for record in response.data.records:
print(f'AppId: {record.appId}')
print(f'RecordId: {record.recordId}')
print(f'AppId: {record.app_id}')
print(f'RecordId: {record.record_id}')
for field in record.fields:
print(f'Type: {field.type}')
print(f'FieldId: {field.fieldId}')
print(f'Value: {field.GetResultValueString()}')
print(f'FieldId: {field.field_id}')
print(f'Value: {field.value}')
```
```rust
@@ -87,40 +87,42 @@ console.log(newRecordId);
```
```python
from OnspringApiSdk.OnspringClient import OnspringClient
from OnspringApiSdk.Models import StringFieldValue, GuidFieldValue, DateFieldValue, IntegerListValue, Record
from onspring_api_sdk import OnspringClient
from onspring_api_sdk.models import StringFieldValue, GuidFieldValue, DateFieldValue, IntegerListValue, Record
import uuid
from datetime import datetime
from configparser import ConfigParser
cfg = ConfigParser()
cfg.read('config.ini')
key = cfg['prod']['key']
url = cfg['prod']['url']
client = OnspringClient(url, key)
fields = []
fields.append(StringFieldValue(6983, 'A New Test Task'))
fields.append(StringFieldValue(6984, 'This is a test task.'))
fields.append(StringFieldValue(field_id=6983, value='A New Test Task'))
fields.append(StringFieldValue(field_id=6984, value='This is a test task.'))
fields.append(
GuidFieldValue(
6986,
uuid.UUID('4118d53a-9121-4345-8682-07f23d606daa')
)
GuidFieldValue(field_id=6986, value=uuid.UUID('4118d53a-9121-4345-8682-07f23d606daa'))
)
fields.append(
DateFieldValue(
6985,
datetime.datetime(2021, 12, 25)
DateFieldValue(field_id=6985, value=datetime(2021, 12, 25))
)
)
fields.append(IntegerListValue(6987, [4]))
fields.append(IntegerListValue(field_id=6987, value=[4]))
record = Record(
appId=195,
fields
)
record = Record(app_id=195, fields=fields)
response = client.AddOrUpdateRecord(record)
response = client.add_or_update_record(record)
print(f'Status Code: {response.statusCode}')
print(f'Status Code: {response.status_code}')
print(f'Id: {response.data.id}')
for warning in response.data.warnings:
print(f'Warning: {warning}')
```
```rust
@@ -41,8 +41,8 @@ console.log(report);
```
```python
from OnspringApiSdk.OnspringClient import OnspringClient
from OnspringApiSdk.Models import GetReportByIdRequest
from onspring_api_sdk import OnspringClient
from onspring_api_sdk.models import GetReportByIdRequest
from configparser import ConfigParser
cfg = ConfigParser()
@@ -52,16 +52,17 @@ key = cfg['prod']['key']
url = cfg['prod']['url']
client = OnspringClient(url, key)
request = GetReportByIdRequest(reportId=613)
response = client.GetReportById(request)
request = GetReportByIdRequest(report_id=613)
response = client.get_report_by_id(request)
print(f'Status Code: {response.statusCode}')
print(f'Status Code: {response.status_code}')
print('Columns:')
print(f'{", ".join(response.data.columns)}')
print('Rows:')
for row in response.data.rows:
print(f'Record Id {row.recordId}: {", ".join([str(cell) for cell in row.cells])}')
print(f'Record Id {row.record_id}: {", ".join([str(cell) for cell in row.cells])}')
```
```rust
@@ -42,7 +42,7 @@ for (const report of reports) {
```
```python
from OnspringApiSdk.OnspringClient import OnspringClient
from onspring_api_sdk import OnspringClient
from configparser import ConfigParser
cfg = ConfigParser()
@@ -52,16 +52,18 @@ key = cfg['prod']['key']
url = cfg['prod']['url']
client = OnspringClient(url, key)
response = client.GetReportsByAppId(appId=195)
app_id = 195
response = client.get_reports_by_app_id(app_id=app_id)
print(f'Status Code: {response.statusCode}')
print(f'App Id: {appId}')
print(f'Status Code: {response.status_code}')
print(f'App Id: {app_id}')
print('Reports:')
for report in response.data.reports:
print(f' Id: {report.id}')
print(f' Name: {report.name}')
print(f' Description: {report.description}')
```
```rust