ModelDerivativeAPI - add support for x-ads-headers and advanced translation options

.gitignore

@@ -65,3 +65,5 @@ crashlytics.properties
 crashlytics-build.properties
 fabric.properties
 .idea/
+
+.vscode/

LICENSE

@@ -1,6 +1,7 @@
 MIT License
 
 Copyright (c) 2017 Denis Grigor
+Portions Copyright (c) 2022-2023 Wolfgang Weh
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,17 +1,90 @@
-[![Build Status](https://travis-ci.org/apprentice3d/forge-api-go-client.svg?branch=master)](https://travis-ci.org/apprentice3d/forge-api-go-client)
-[![GoDoc](https://godoc.org/github.com/apprentice3d/forge-api-go-client?status.svg)](https://godoc.org/github.com/apprentice3d/forge-api-go-client)
-[![Go Report Card](https://goreportcard.com/badge/github.com/apprentice3d/forge-api-go-client)](https://goreportcard.com/report/github.com/apprentice3d/forge-api-go-client)
+[![GoDoc](https://godoc.org/github.com/woweh/forge-api-go-client?status.svg)](https://godoc.org/github.com/woweh/forge-api-go-client)
+[![Go Report Card](https://goreportcard.com/badge/github.com/woweh/forge-api-go-client)](https://goreportcard.com/report/github.com/woweh/forge-api-go-client)
 
 # forge-api-go-client
 
 
-**Forge API:** [![oAuth2](https://img.shields.io/badge/oAuth2-v2-green.svg)](http://developer-autodesk.github.io/)
-[![Data-Management](https://img.shields.io/badge/Data%20Management-v1-green.svg)](http://autodesk-forge.github.io/)
-[![OSS](https://img.shields.io/badge/OSS-v2-green.svg)](http://autodesk-forge.github.io/)
-[![Model-Derivative](https://img.shields.io/badge/Model%20Derivative-v2-green.svg)](http://autodesk-forge.github.io/)
-[![Reality-Capture](https://img.shields.io/badge/Reality%20Capture-v1-green.svg)](http://developer-autodesk.github.io/)
+**Autodesk Platform Services APIs:**  
+[![Authentication](https://img.shields.io/badge/Authentication-v2-green.svg)](https://aps.autodesk.com/en/docs/oauth/v2/developers_guide/overview/)
+[![Data-Management](https://img.shields.io/badge/Data%20Management-v2-green.svg)](https://aps.autodesk.com/en/docs/data/v2/developers_guide/)
+[![Model-Derivative](https://img.shields.io/badge/Model%20Derivative-v2-green.svg)](https://aps.autodesk.com/en/docs/model-derivative/v2/developers_guide/)
 
 
-Golang SDK for building Forge based applications
+Golang API client for building APS based applications ([Autodesk Platform Services], formerly *"Forge"*).
 
+This is a fork of the [forge-api-go-client by Denis Grigor](https://github.com/apprentice3d/forge-api-go-client).  
+The original client is no longer maintained.  
+This forks has been updated and extended with new features.
 
+---
+## Supported and maintained APIs
+Note that this client only covers a subset of the APS APIs.  
+
+At the time of writing (2023/06/15), only the following APIs are maintained:
+1. Authentication (oauth)
+2. Data Management (dm)
+3. Model Derivative (md)
+
+The following APIs are not maintained:
+1. Reality Capture (rc)
+2. Design Automation (da)
+
+Autodesk is constantly adding new APIs and changing existing APIs.  
+A lot of the new APIs are not covered by this client.
+
+You are invited to contribute 🧑🏽‍💻!  
+Please fork  and add missing APIs.
+
+---
+## Updates from the original client
+
+The client has been extended with the following features.  
+Note that there are a number of breaking changes.
+
+### Authentication (oauth):
+- Update to OAuth V2.  
+  See: https://aps.autodesk.com/blog/migration-guide-oauth2-v1-v2
+
+
+### Data Management API (dm):
+- Update `upload object` and `download object` to use the direct-to-s3 approach (breaking change).  
+  See:
+  - https://forge.autodesk.com/blog/data-management-oss-object-storage-service-migrating-direct-s3-approach
+  - https://forge.autodesk.com/en/docs/data/v2/reference/http/buckets-:bucketKey-objects-:objectKey-signeds3upload-GET/
+  - https://forge.autodesk.com/en/docs/data/v2/reference/http/buckets-:bucketKey-objects-:objectKey-signeds3download-GET/
+- Add support for regions (US <> EMEA):  
+  See: https://aps.autodesk.com/blog/data-management-and-model-derivative-regions
+- dm Initialization now requires a region (breaking change).
+- BucketAPI is renamed to OssAPI (breaking change).
+- The API is changed to use pointer receivers.
+- Update ListBuckets to list all buckets.  
+  See: https://aps.autodesk.com/en/docs/data/v2/reference/http/buckets-GET/
+- Fix and update unit tests. You need a valid APS account (client ID and secret) to run the tests.  
+  => Best run the tests locally, or on a private CI server.
+
+
+### Model Derivative API (md):
+- Add support for x-ads-headers and advanced translation options (input > formats > advanced).  
+  See: https://forge.autodesk.com/en/docs/model-derivative/v2/reference/http/jobs/job-POST/
+- Update GET derivatives to use the `signedcookies` endpoint.  
+  See:
+  - https://aps.autodesk.com/blog/data-management-oss-object-storage-service-migrating-direct-s3-approach
+  - https://aps.autodesk.com/en/docs/model-derivative/v2/reference/http/urn-manifest-derivativeUrn-signedcookies-GET/
+- Add support for regions (US <> EMEA):  
+  See: https://aps.autodesk.com/blog/data-management-and-model-derivative-regions
+- md Initialization now requires a region (breaking change).  
+- Add support for downloading all properties.  
+  See: https://aps.autodesk.com/en/docs/model-derivative/v2/reference/http/metadata/urn-metadata-guid-properties-GET/
+- Add support for fetching the object tree.  
+  See: https://aps.autodesk.com/en/docs/model-derivative/v2/reference/http/metadata/urn-metadata-guid-GET/
+- The API is changed to use pointer receivers.
+- Fix and update unit tests. You need a valid APS account (client ID and secret) to run the tests.  
+  => Best run the tests locally, or on a private CI server.
+
+---
+## TODO:
+- Create proper changelog.
+- Add support for more APIs.
+
+---
+[Autodesk Platform Services]: https://aps.autodesk.com/

api_types.go

@@ -0,0 +1,35 @@
+package forge
+
+// This file contains types and constants for the entire APS (aka Forge) API.
+
+import "strings"
+
+// HostName / domain of the Autodesk Forge API.
+const HostName = "https://developer.api.autodesk.com"
+
+// Region is the region where the data resides.
+type Region string
+
+const (
+	US   Region = "us"   // US Region - us in lowercase!
+	EU   Region = "emea" // EU (== EMEA) Region - emea in lowercase!
+	EMEA Region = "emea" // EMEA (== EU) Region - emea in lowercase!
+)
+
+// IsUS returns true if the region is US.
+func (r Region) IsUS() bool {
+	// case insensitive comparison!
+	return strings.EqualFold(string(r), string(US))
+}
+
+// IsEMEA returns true if the region is EMEA (== EU).
+func (r Region) IsEMEA() bool {
+	// case insensitive comparison!
+	return strings.EqualFold(string(r), string(EMEA))
+}
+
+// IsEU returns true if the region is EU (== EMEA).
+func (r Region) IsEU() bool {
+	// case insensitive comparison!
+	return strings.EqualFold(string(r), string(EU))
+}