Supported Versions and Dependencies
This page lists the supported language/framework versions and dependencies in each of the SDKs generated by APIMatic.
Supported SDK Language Versions
This table lists all supported versions for each supported SDK language.
| Language/Platform | Supported Versions |
|---|---|
| C# (a.k.a .NET) | .NET Standard 2.0. See compatibility table. Note that our SDK uses C# language version 7.3. |
| Java | Version 8+ |
| PHP | Version 7.2 to 8.1 |
| Python | Version 3.7 to 3.9 |
| Ruby | Version >= 2.6 |
| TypeScript | TypeScript Version 3.9+ For Node.js environment: Node.js Version 10.4.0+ For the browser environment: All modern browsers are supported. For older browsers, some polyfills might be needed. |
Reference: .NET Standard Versions
This table shows the compatibility of .NET Standard 2.0 (used in our SDK right now) with .NET Core, .NET Framework and other .NET platforms’ versions.
Source: https://dotnet.microsoft.com/platform/dotnet-standard#versions
Supported Dependencies
This section covers all mandatory and optional dependencies for each SDK along with any specific use cases where the dependency may be required.
Java SDK
| Dependency | Version | Mandatory/Optional | Use Cases |
|---|---|---|---|
| okhttp | 4.9.1 | Mandatory | All SDKs |
| jackson-databind | 2.12.3 | Mandatory | All SDKs |
| jackson-core | 2.12.3 | Mandatory | All SDKs |
| jackson-annotations | 2.12.3 | Mandatory | All SDKs |
| junit | 4.13.1 | Optional | In case of test cases |
| jaxb-api | 2.4.0-b180830.0359 | Optional | In case of XML API specification |
| httpcore | 4.4.10 | Optional | In cases like OAuth1TokenSecret or OAuth1CertPKCS12O or Auth1OneLegged |
| commons-codec | 1.11 | Optional | In cases like OAuth1TokenSecret or OAuth1CertPKCS12O or Auth1OneLegged or OAuth2 |
| jackson-jsog | 1.1.1 | Optional | In case of jsog Identity type in models |
| slf4j-api | 1.7.30 | Optional | In case of logging |
C# Standard Project
| Dependency | Version | Mandatory/Optional | Use Cases |
|---|---|---|---|
| Newtonsoft.Json | 11.0.2 | Mandatory | All standard projects |
| Polly | 7.2.1 | Mandatory | All standard projects |
| System.Collections.Immutable | 1.5.0 | Mandatory | All standard projects |
| System.Xml.XmlSerializer | 4.3.0 | Optional | If ApiUsesXml is true |
| JsonSubTypes | 1.6.0 | Optional | If ApiHasDiscriminator is true |
| APIMATIC.SDK.Common | 2.1.7 | Optional | If UseCommonSDKLibrary is true |
| Microsoft.Bcl.HashCode | 1.1.1 | Optional | If EnableImmutableModels is true |
C# Test Project
| Dependency | Version | Mandatory/Optional | Use Cases |
|---|---|---|---|
| Microsoft.NET.Test.Sdk | 15.0.0 | Mandatory | All test projects |
| NUnit | 3.12 | Mandatory | All test projects |
| NUnit3TestAdapter | 3.15.1 | Mandatory | All test projects |
Python SDK
| Dependency | Version | Mandatory/Optional | Use Cases |
|---|---|---|---|
| requests | ~=2.25.0 | Mandatory | All SDKs |
| jsonpickle | ~=1.4, >= 1.4.1 | Mandatory | All SDKs |
| cachecontrol | ~=0.12.6 | Mandatory | All SDKs |
| python-dateutil | ~=2.8.1 | Mandatory | All SDKs |
| enum34 | ~=1.1, >=1.1.10 | Optional | If the API uses models |
| nose | >=1.3.7 | Optional | In case of tests |
| jsonschema | ~=3.2.0 | Optional | In case of oneOf/anyOf |
Ruby SDK
| Dependency | Version | Mandatory/Optional | Use Cases |
|---|---|---|---|
| logging | ~> 2.3 | Mandatory | All SDKs |
| faraday | ~> 2.0, >= 2.0.1 | Mandatory | All SDKs |
| faraday-follow_redirects | ~> 2.0 | Mandatory | All SDKs |
| faraday-multipart | ~> 1.0 | Mandatory | All SDKs |
| faraday-gzip | ~> 0.1 | Mandatory | All SDKs |
| faraday-retry | ~> 1.0 | Mandatory | All SDKs |
| certifi | ~> 2018.1, >= 2018.01.18 | Mandatory | All SDKs |
| faraday-http-cache | ~> 2.2 | Mandatory | All SDKs |
| minitest | ~> 5.14, >= 5.14.1 | Optional | In case of tests |
| minitest-proveit | ~> 1.0 | Optional | In case of tests |
| nokogiri | ~> 1.10, >=1.10.10 | Optional | In case of XML |
PHP SDK
| Dependency | Version | Required/Development | Use Cases |
|---|---|---|---|
| ext-curl | latest | Required | All SDKs |
| ext-json | latest | Required | All SDKs |
| ext-mbstring | latest | Required | All SDKs |
| apimatic/unirest-php | >=2.1 <3.0 | Required | All SDKs |
| apimatic/jsonmapper | >=2.0.2 <3.0.0 | Required | In case of tests |
| squizlabs/php_codesniffer | >=3.5 <4.0 | Development | If CodegenSetting.DisableLinting is false |
| phan/phan | 5.3.1 | Development | If CodegenSetting.DisableLinting is false |
| phpunit/phpunit | >=7.5 <8.0 | >=8.5 <9.0 |
TypeScript SDK
| Dependency | Version | Mandatory/Optional | Use Cases |
|---|---|---|---|
| @apimatic/schema | 0.6.0 | Mandatory | All SDKs |
| @apimatic/core | 0.7.6 | Mandatory | All SDKs |
| xml2js | 0.4.23 | Optional | All SDKs |
| typescript | 3.9.7 | Mandatory | All SDKs |
| stream-equal | 2.0.1 | Mandatory | All SDKs |
| tsdx | 0.14.1 | Mandatory | All SDKs |
| tslib | 2.1.0 | Mandatory | All SDKs |
| @types/xml2js | 0.4.5 | Optional | In case of XML specs |