diff --git a/src/app/components/Clients.tsx b/src/app/components/Clients.tsx index 97739d8..e47b319 100644 --- a/src/app/components/Clients.tsx +++ b/src/app/components/Clients.tsx @@ -78,6 +78,20 @@ export default function Clients({ `, official: false, }, + { + name: 'Go', + repoLink: + 'https://github.com/StevanFreeborn/onspring-api-sdk-go', + installCommand: + 'go get github.com/StevanFreeborn/onspring-api-sdk-go', + svg: ` + + + + + `, + official: false, + }, ], } as { [key: string]: { diff --git a/src/app/components/Fence.tsx b/src/app/components/Fence.tsx index 02b7154..004e2a1 100644 --- a/src/app/components/Fence.tsx +++ b/src/app/components/Fence.tsx @@ -4,6 +4,7 @@ import 'prismjs/components/prism-csharp'; import 'prismjs/components/prism-json'; import 'prismjs/components/prism-python'; import 'prismjs/components/prism-rust'; +import 'prismjs/components/prism-go'; import './prism-custom.css'; export default function Fence({ diff --git a/src/docs/version_002/resources/apps/get_app_by_id/example.md b/src/docs/version_002/resources/apps/get_app_by_id/example.md index e1f1e1e..3a57588 100644 --- a/src/docs/version_002/resources/apps/get_app_by_id/example.md +++ b/src/docs/version_002/resources/apps/get_app_by_id/example.md @@ -73,6 +73,21 @@ println!( ); ``` +```go +import onspring "github.com/StevanFreeborn/onspring-api-sdk-go" + +client := onspring.NewClient( + "000000ffffff000000ffffff/00000000-ffff-0000-ffff-000000000000", +) + +app, _ := client.Apps.Get( + context.Background(), + 195, +) + +fmt.Printf("%d, %s\n", app.Id, app.Name) +``` + {% /code %} {% code heading="RESPONSE" defaultLanguage="json" %} diff --git a/src/docs/version_002/resources/apps/get_apps/example.md b/src/docs/version_002/resources/apps/get_apps/example.md index e8841c8..13baaa6 100644 --- a/src/docs/version_002/resources/apps/get_apps/example.md +++ b/src/docs/version_002/resources/apps/get_apps/example.md @@ -90,6 +90,22 @@ for app in response.items.unwrap_or_default() { } ``` +```go +import onspring "github.com/StevanFreeborn/onspring-api-sdk-go" + +client := onspring.NewClient( + "000000ffffff000000ffffff/00000000-ffff-0000-ffff-000000000000", +) + +page, _ := client.Apps.List( + context.Background(), +) + +for _, app := range page.Items { + fmt.Printf("%d, %s\n", app.Id, app.Name) +} +``` + {% /code %} {% code heading="RESPONSE" defaultLanguage="json" %} diff --git a/src/docs/version_002/resources/apps/get_apps_by_ids/example.md b/src/docs/version_002/resources/apps/get_apps_by_ids/example.md index 2cb90cd..cd0dbd4 100644 --- a/src/docs/version_002/resources/apps/get_apps_by_ids/example.md +++ b/src/docs/version_002/resources/apps/get_apps_by_ids/example.md @@ -87,6 +87,23 @@ for app in response.items.unwrap_or_default() { } ``` +```go +import onspring "github.com/StevanFreeborn/onspring-api-sdk-go" + +client := onspring.NewClient( + "000000ffffff000000ffffff/00000000-ffff-0000-ffff-000000000000", +) + +batch, _ := client.Apps.GetMany( + context.Background(), + []int{8, 79, 137, 193, 183}, +) + +for _, app := range batch.Items { + fmt.Printf("%d, %s\n", app.Id, app.Name) +} +``` + {% /code %} {% code heading="RESPONSE" defaultLanguage="json" %} diff --git a/src/docs/version_002/resources/connectivity/example.md b/src/docs/version_002/resources/connectivity/example.md index 5b3cccf..5a50874 100644 --- a/src/docs/version_002/resources/connectivity/example.md +++ b/src/docs/version_002/resources/connectivity/example.md @@ -68,4 +68,18 @@ client.ping().await?; println!("Connected to the Onspring API successfully."); ``` +```go +import onspring "github.com/StevanFreeborn/onspring-api-sdk-go" + +client := onspring.NewClient( + "000000ffffff000000ffffff/00000000-ffff-0000-ffff-000000000000", +) + +err := client.Ping.Get(context.Background()) + +if err == nil { + fmt.Println("Connected to Onspring API") +} +``` + {% /code %} diff --git a/src/docs/version_002/resources/fields/get_field_by_id/example.md b/src/docs/version_002/resources/fields/get_field_by_id/example.md index 1bbc8f2..c779412 100644 --- a/src/docs/version_002/resources/fields/get_field_by_id/example.md +++ b/src/docs/version_002/resources/fields/get_field_by_id/example.md @@ -67,6 +67,21 @@ let field = client.get_field(6986).await?; println!("Field Id: {}", field.id); ``` +```go +import onspring "github.com/StevanFreeborn/onspring-api-sdk-go" + +client := onspring.NewClient( + "000000ffffff000000ffffff/00000000-ffff-0000-ffff-000000000000", +) + +field, _ := client.Fields.Get( + context.Background(), + 6986, +) + +fmt.Printf("Field Id: %d\n", field.Id) +``` + {% /code %} {% code heading="RESPONSE" defaultLanguage="json" %} diff --git a/src/docs/version_002/resources/fields/get_fields_by_app/example.md b/src/docs/version_002/resources/fields/get_fields_by_app/example.md index 55d9cba..4b522ff 100644 --- a/src/docs/version_002/resources/fields/get_fields_by_app/example.md +++ b/src/docs/version_002/resources/fields/get_fields_by_app/example.md @@ -84,6 +84,23 @@ for field in response.items.unwrap_or_default() { } ``` +```go +import onspring "github.com/StevanFreeborn/onspring-api-sdk-go" + +client := onspring.NewClient( + "000000ffffff000000ffffff/00000000-ffff-0000-ffff-000000000000", +) + +page, _ := client.Fields.List( + context.Background(), + 195, +) + +for _, field := range page.Items { + fmt.Printf("Field Id: %d\n", field.Id) +} +``` + {% /code %} {% code heading="RESPONSE" defaultLanguage="json" %} diff --git a/src/docs/version_002/resources/fields/get_fields_by_ids/example.md b/src/docs/version_002/resources/fields/get_fields_by_ids/example.md index 28bd272..44142aa 100644 --- a/src/docs/version_002/resources/fields/get_fields_by_ids/example.md +++ b/src/docs/version_002/resources/fields/get_fields_by_ids/example.md @@ -79,6 +79,23 @@ for field in response.items.unwrap_or_default() { } ``` +```go +import onspring "github.com/StevanFreeborn/onspring-api-sdk-go" + +client := onspring.NewClient( + "000000ffffff000000ffffff/00000000-ffff-0000-ffff-000000000000", +) + +batch, _ := client.Fields.GetMany( + context.Background(), + []int{6983, 6986, 6987, 6985, 6984}, +) + +for _, field := range batch.Items { + fmt.Printf("Field Id: %d\n", field.Id) +} +``` + {% /code %} {% code heading="RESPONSE" defaultLanguage="json" %} diff --git a/src/docs/version_002/resources/files/add_file/example.md b/src/docs/version_002/resources/files/add_file/example.md index 40da4b3..421f4c1 100644 --- a/src/docs/version_002/resources/files/add_file/example.md +++ b/src/docs/version_002/resources/files/add_file/example.md @@ -121,6 +121,29 @@ let response = client.upload_file(request).await?; println!("New File Id is: {}", response.id); ``` +```go +import onspring "github.com/StevanFreeborn/onspring-api-sdk-go" + +client := onspring.NewClient( + "000000ffffff000000ffffff/00000000-ffff-0000-ffff-000000000000", +) + +file, _ := os.Open("test-attachment.txt") + +response, _ := client.Files.Save( + context.Background(), + onspring.SaveFileRequest{ + RecordId: 140, + FieldId: 6989, + Notes: "Updating record with attachment.", + FileName: "test-attachment.txt", + FileContents: file, + }, +) + +fmt.Printf("New File Id is: %d\n", response.Id) +``` + {% /code %} {% code heading="RESPONSE" defaultLanguage="json" %} diff --git a/src/docs/version_002/resources/files/delete_file_by_id/example.md b/src/docs/version_002/resources/files/delete_file_by_id/example.md index ea09a2a..a17ce98 100644 --- a/src/docs/version_002/resources/files/delete_file_by_id/example.md +++ b/src/docs/version_002/resources/files/delete_file_by_id/example.md @@ -73,4 +73,23 @@ client.delete_file(140, 6989, 1904).await?; println!("File deleted successfully"); ``` +```go +import onspring "github.com/StevanFreeborn/onspring-api-sdk-go" + +client := onspring.NewClient( + "000000ffffff000000ffffff/00000000-ffff-0000-ffff-000000000000", +) + +err := client.Files.Delete( + context.Background(), + 140, + 6989, + 1904, +) + +if err == nil { + fmt.Println("File deleted successfully") +} +``` + {% /code %} diff --git a/src/docs/version_002/resources/files/get_file_by_id/example.md b/src/docs/version_002/resources/files/get_file_by_id/example.md index 66e741d..82914eb 100644 --- a/src/docs/version_002/resources/files/get_file_by_id/example.md +++ b/src/docs/version_002/resources/files/get_file_by_id/example.md @@ -95,6 +95,27 @@ println!("Size: {} bytes", file.data.len()); std::fs::write(&file.file_name, &file.data)?; ``` +```go +import onspring "github.com/StevanFreeborn/onspring-api-sdk-go" + +client := onspring.NewClient( + "000000ffffff000000ffffff/00000000-ffff-0000-ffff-000000000000", +) + +file, _ := client.Files.GetContent( + context.Background(), + 1, + 6989, + 89, +) + +fmt.Printf("File Name: %s\n", file.FileName) +fmt.Printf("Content Type: %s\n", file.ContentType) +fmt.Printf("Size: %d bytes\n", len(file.Data)) + +os.WriteFile(file.FileName, file.Data, 0644) +``` + {% /code %} {% code heading="RESPONSE" defaultLanguage="text" %} diff --git a/src/docs/version_002/resources/files/get_file_info_by_id/example.md b/src/docs/version_002/resources/files/get_file_info_by_id/example.md index d3b6316..2d23b44 100644 --- a/src/docs/version_002/resources/files/get_file_info_by_id/example.md +++ b/src/docs/version_002/resources/files/get_file_info_by_id/example.md @@ -69,6 +69,24 @@ println!("Name: {:?}", info.name); println!("Content Type: {:?}", info.content_type); ``` +```go +import onspring "github.com/StevanFreeborn/onspring-api-sdk-go" + +client := onspring.NewClient( + "000000ffffff000000ffffff/00000000-ffff-0000-ffff-000000000000", +) + +info, _ := client.Files.GetInfo( + context.Background(), + 1, + 6989, + 89, +) + +fmt.Printf("Name: %s\n", info.Name) +fmt.Printf("Content Type: %s\n", info.ContentType) +``` + {% /code %} {% code heading="RESPONSE" defaultLanguage="json" %} diff --git a/src/docs/version_002/resources/list_values/delete_list_value_by_id/example.md b/src/docs/version_002/resources/list_values/delete_list_value_by_id/example.md index e5a42e6..68692ae 100644 --- a/src/docs/version_002/resources/list_values/delete_list_value_by_id/example.md +++ b/src/docs/version_002/resources/list_values/delete_list_value_by_id/example.md @@ -85,4 +85,22 @@ client.delete_list_item(906, item_id).await?; println!("List item deleted"); ``` +```go +import onspring "github.com/StevanFreeborn/onspring-api-sdk-go" + +client := onspring.NewClient( + "000000ffffff000000ffffff/00000000-ffff-0000-ffff-000000000000", +) + +err := client.Lists.Delete( + context.Background(), + 906, + "e3371dbf-b557-4a31-b32f-33c0265d2a59", +) + +if err == nil { + fmt.Println("List item deleted") +} +``` + {% /code %} diff --git a/src/docs/version_002/resources/list_values/save_list_value/example.md b/src/docs/version_002/resources/list_values/save_list_value/example.md index f1f00f6..9858502 100644 --- a/src/docs/version_002/resources/list_values/save_list_value/example.md +++ b/src/docs/version_002/resources/list_values/save_list_value/example.md @@ -111,6 +111,29 @@ let response = client println!("Id: {}", response.id); ``` +```go +import onspring "github.com/StevanFreeborn/onspring-api-sdk-go" + +client := onspring.NewClient( + "000000ffffff000000ffffff/00000000-ffff-0000-ffff-000000000000", +) + +numericValue := 0.0 +color := "#ffffff" + +response, _ := client.Lists.Save( + context.Background(), + 906, + onspring.SaveListItemRequest{ + Name: "Not Started", + NumericValue: &numericValue, + Color: &color, + }, +) + +fmt.Printf("Id: %s\n", response.Id) +``` + {% /code %} {% code heading="RESPONSE" defaultLanguage="json" %} diff --git a/src/docs/version_002/resources/records/delete_record_by_id/example.md b/src/docs/version_002/resources/records/delete_record_by_id/example.md index 6ca5672..7319fa1 100644 --- a/src/docs/version_002/resources/records/delete_record_by_id/example.md +++ b/src/docs/version_002/resources/records/delete_record_by_id/example.md @@ -71,4 +71,22 @@ client.delete_record(195, 140).await?; println!("Record deleted"); ``` +```go +import onspring "github.com/StevanFreeborn/onspring-api-sdk-go" + +client := onspring.NewClient( + "000000ffffff000000ffffff/00000000-ffff-0000-ffff-000000000000", +) + +err := client.Records.Delete( + context.Background(), + 195, + 140, +) + +if err == nil { + fmt.Println("Record deleted") +} +``` + {% /code %} diff --git a/src/docs/version_002/resources/records/delete_records_by_ids/example.md b/src/docs/version_002/resources/records/delete_records_by_ids/example.md index 90b50d8..391ea29 100644 --- a/src/docs/version_002/resources/records/delete_records_by_ids/example.md +++ b/src/docs/version_002/resources/records/delete_records_by_ids/example.md @@ -91,4 +91,24 @@ client.batch_delete_records(request).await?; println!("Records deleted successfully"); ``` +```go +import onspring "github.com/StevanFreeborn/onspring-api-sdk-go" + +client := onspring.NewClient( + "000000ffffff000000ffffff/00000000-ffff-0000-ffff-000000000000", +) + +err := client.Records.DeleteMany( + context.Background(), + onspring.DeleteManyRecordsRequest{ + AppId: 195, + RecordIds: []int{138, 139}, + }, +) + +if err == nil { + fmt.Println("Records deleted successfully") +} +``` + {% /code %} diff --git a/src/docs/version_002/resources/records/get_record_by_id/example.md b/src/docs/version_002/resources/records/get_record_by_id/example.md index b161245..6506ec6 100644 --- a/src/docs/version_002/resources/records/get_record_by_id/example.md +++ b/src/docs/version_002/resources/records/get_record_by_id/example.md @@ -100,6 +100,35 @@ if let Some(field_data) = record.field_data { } ``` +```go +import onspring "github.com/StevanFreeborn/onspring-api-sdk-go" + +client := onspring.NewClient( + "000000ffffff000000ffffff/00000000-ffff-0000-ffff-000000000000", +) + +record, _ := client.Records.Get( + context.Background(), + 195, + 1, +) + +fmt.Printf( + "AppId: %d, RecordId: %d\n", + record.AppId, + record.RecordId, +) + +for _, field := range record.FieldData { + fmt.Printf( + "FieldId: %d, Type: %s, Value: %v\n", + field.FieldId, + field.Type, + field.Value, + ) +} +``` + {% /code %} {% code heading="RESPONSE" defaultLanguage="json" %} diff --git a/src/docs/version_002/resources/records/get_records_by_app/example.md b/src/docs/version_002/resources/records/get_records_by_app/example.md index c7e0b6e..3020200 100644 --- a/src/docs/version_002/resources/records/get_records_by_app/example.md +++ b/src/docs/version_002/resources/records/get_records_by_app/example.md @@ -97,6 +97,27 @@ for record in response.items.unwrap_or_default() { } ``` +```go +import onspring "github.com/StevanFreeborn/onspring-api-sdk-go" + +client := onspring.NewClient( + "000000ffffff000000ffffff/00000000-ffff-0000-ffff-000000000000", +) + +page, _ := client.Records.List( + context.Background(), + 195, +) + +for _, record := range page.Items { + fmt.Printf( + "AppId: %d, RecordId: %d\n", + record.AppId, + record.RecordId, + ) +} +``` + {% /code %} {% code heading="RESPONSE" defaultLanguage="json" %} diff --git a/src/docs/version_002/resources/records/get_records_by_ids/example.md b/src/docs/version_002/resources/records/get_records_by_ids/example.md index 0a1cd83..88657b9 100644 --- a/src/docs/version_002/resources/records/get_records_by_ids/example.md +++ b/src/docs/version_002/resources/records/get_records_by_ids/example.md @@ -128,6 +128,32 @@ for record in response.items.unwrap_or_default() { } ``` +```go +import onspring "github.com/StevanFreeborn/onspring-api-sdk-go" + +client := onspring.NewClient( + "000000ffffff000000ffffff/00000000-ffff-0000-ffff-000000000000", +) + +batch, _ := client.Records.GetMany( + context.Background(), + onspring.GetManyRecordsRequest{ + AppId: 195, + RecordIds: []int{1}, + FieldIds: []int{6983, 6986, 6987, 6985, 6984}, + DataFormat: "Raw", + }, +) + +for _, record := range batch.Items { + fmt.Printf( + "AppId: %d, RecordId: %d\n", + record.AppId, + record.RecordId, + ) +} +``` + {% /code %} {% code heading="RESPONSE" defaultLanguage="json" %} diff --git a/src/docs/version_002/resources/records/get_records_by_query/example.md b/src/docs/version_002/resources/records/get_records_by_query/example.md index 83407a3..af09c07 100644 --- a/src/docs/version_002/resources/records/get_records_by_query/example.md +++ b/src/docs/version_002/resources/records/get_records_by_query/example.md @@ -154,6 +154,32 @@ for record in response.items.unwrap_or_default() { } ``` +```go +import onspring "github.com/StevanFreeborn/onspring-api-sdk-go" + +client := onspring.NewClient( + "000000ffffff000000ffffff/00000000-ffff-0000-ffff-000000000000", +) + +page, _ := client.Records.Query( + context.Background(), + onspring.QueryRecordsRequest{ + AppId: 195, + Filter: "6983 eq 'Test Task 5'", + FieldIds: []int{6983, 6986, 6987, 6985, 6984}, + DataFormat: "Formatted", + }, +) + +for _, record := range page.Items { + fmt.Printf( + "AppId: %d, RecordId: %d\n", + record.AppId, + record.RecordId, + ) +} +``` + {% /code %} {% code heading="RESPONSE" defaultLanguage="json" %} diff --git a/src/docs/version_002/resources/records/save_record/example.md b/src/docs/version_002/resources/records/save_record/example.md index 5ed0b82..5954d55 100644 --- a/src/docs/version_002/resources/records/save_record/example.md +++ b/src/docs/version_002/resources/records/save_record/example.md @@ -165,6 +165,30 @@ let response = client.save_record(request).await?; println!("New Record Id is: {}", response.id); ``` +```go +import onspring "github.com/StevanFreeborn/onspring-api-sdk-go" + +client := onspring.NewClient( + "000000ffffff000000ffffff/00000000-ffff-0000-ffff-000000000000", +) + +response, _ := client.Records.Save( + context.Background(), + onspring.SaveRecordRequest{ + AppId: 195, + Fields: map[string]any{ + "6983": "A New Test Task", + "6984": "This is a test task.", + "6985": "12/25/2021", + "6986": "4118d53a-9121-4345-8682-07f23d606daa", + "6987": []int{4}, + }, + }, +) + +fmt.Printf("New Record Id is: %d\n", response.Id) +``` + {% /code %} {% code heading="Response" defaultLanguage="json" %} diff --git a/src/docs/version_002/resources/reports/get_report_by_id/example.md b/src/docs/version_002/resources/reports/get_report_by_id/example.md index de0614f..e58f73d 100644 --- a/src/docs/version_002/resources/reports/get_report_by_id/example.md +++ b/src/docs/version_002/resources/reports/get_report_by_id/example.md @@ -89,6 +89,29 @@ if let Some(rows) = data.rows { } ``` +```go +import onspring "github.com/StevanFreeborn/onspring-api-sdk-go" + +client := onspring.NewClient( + "000000ffffff000000ffffff/00000000-ffff-0000-ffff-000000000000", +) + +data, _ := client.Reports.Get( + context.Background(), + 613, +) + +fmt.Printf("Columns: %v\n", data.Columns) + +for _, row := range data.Rows { + fmt.Printf( + "Record Id %v: %v\n", + row.RecordId, + row.Cells, + ) +} +``` + {% /code %} {% code heading="RESPONSE" defaultLanguage="json" %} diff --git a/src/docs/version_002/resources/reports/get_reports_by_app/example.md b/src/docs/version_002/resources/reports/get_reports_by_app/example.md index 73f8422..3dc454d 100644 --- a/src/docs/version_002/resources/reports/get_reports_by_app/example.md +++ b/src/docs/version_002/resources/reports/get_reports_by_app/example.md @@ -91,6 +91,28 @@ for report in response.items.unwrap_or_default() { } ``` +```go +import onspring "github.com/StevanFreeborn/onspring-api-sdk-go" + +client := onspring.NewClient( + "000000ffffff000000ffffff/00000000-ffff-0000-ffff-000000000000", +) + +page, _ := client.Reports.List( + context.Background(), + 195, +) + +for _, report := range page.Items { + fmt.Printf( + "%d, %d, %s\n", + report.Id, + report.AppId, + report.Name, + ) +} +``` + {% /code %} {% code heading="RESPONSE" defaultLanguage="json" %}