Enhanced SDK documentation for enumeration casing across all supported languages. This update ensures consistent and accurate environment enumeration representation in the Getting Started section for all languages. We also improved enum casing in the model documentation section for Java.
Key Enhancements
Getting Started Environment Section
The SDK README's Getting Started section now displays environment enum values with correct casing, ensuring developers can copy and use the exact values required by the SDK.
Compare how environment enums are now documented:
- Java
- .NET
- Go
- TypeScript
- Ruby
- Python
- PHP
- Before
- After
Environments
The SDK can be configured to use a different environment for making API calls. Available environments are:
Fields
| Name | Description |
|---|---|
| production | Production Environment |
| sandbox | Default Sandbox Environment |
Environments
The SDK can be configured to use a different environment for making API calls. Available environments are:
Fields
| Name | Description |
|---|---|
| PRODUCTION | Production Environment |
| SANDBOX | Default Sandbox Environment |
- Before
- After
Environments
The SDK can be configured to use a different environment for making API calls. Available environments are:
Fields
| Name | Description |
|---|---|
| production | Production Environment |
| sandbox | Default Sandbox Environment |
Environments
The SDK can be configured to use a different environment for making API calls. Available environments are:
Fields
| Name | Description |
|---|---|
| Production | Production Environment |
| Sandbox | Default Sandbox Environment |
- Before
- After
Environments
The SDK can be configured to use a different environment for making API calls. Available environments are:
Fields
| Name | Description |
|---|---|
| production | Production Environment |
| sandbox | Default Sandbox Environment |
Environments
The SDK can be configured to use a different environment for making API calls. Available environments are:
Fields
| Name | Description |
|---|---|
| PRODUCTION | Production Environment |
| SANDBOX | Default Sandbox Environment |
- Before
- After
Environments
The SDK can be configured to use a different environment for making API calls. Available environments are:
Fields
| Name | Description |
|---|---|
| production | Production Environment |
| sandbox | Default Sandbox Environment |
Environments
The SDK can be configured to use a different environment for making API calls. Available environments are:
Fields
| Name | Description |
|---|---|
| Production | Production Environment |
| Sandbox | Default Sandbox Environment |
- Before
- After
Environments
The SDK can be configured to use a different environment for making API calls. Available environments are:
Fields
| Name | Description |
|---|---|
| production | Production Environment |
| sandbox | Default Sandbox Environment |
Environments
The SDK can be configured to use a different environment for making API calls. Available environments are:
Fields
| Name | Description |
|---|---|
| PRODUCTION | Production Environment |
| SANDBOX | Default Sandbox Environment |
- Before
- After
Environments
The SDK can be configured to use a different environment for making API calls. Available environments are:
Fields
| Name | Description |
|---|---|
| production | Production Environment |
| sandbox | Default Sandbox Environment |
Environments
The SDK can be configured to use a different environment for making API calls. Available environments are:
Fields
| Name | Description |
|---|---|
| PRODUCTION | Production Environment |
| SANDBOX | Default Sandbox Environment |
- Before
- After
Environments
The SDK can be configured to use a different environment for making API calls. Available environments are:
Fields
| Name | Description |
|---|---|
| production | Production Environment |
| sandbox | Default Sandbox Environment |
Environments
The SDK can be configured to use a different environment for making API calls. Available environments are:
Fields
| Name | Description |
|---|---|
| PRODUCTION | Production Environment |
| SANDBOX | Default Sandbox Environment |
Enumeration Model Documentation (Java)
The Java SDK README's model documentation section now displays enumeration values with correct casing in the enumeration documentation, ensuring consistency with the actual SDK implementation.
Compare how enumeration models are now documented:
- Before
- After
Days Enum
A string enum representing days of the week
Enumeration
DaysEnum
Fields
| Name |
|---|
Monday |
Tuesday |
Wednesday |
Thursday |
Friday |
Days Enum
A string enum representing days of the week
Enumeration
DaysEnum
Fields
| Name |
|---|
MONDAY |
TUESDAY |
WEDNESDAY |
THURSDAY |
FRIDAY |
Impact
Developers working with enumerations will benefit from:
- Accurate enum casing in documentation that matches the SDK's actual implementation
- Reduced integration errors caused by incorrect enum casing
These improvements are automatically applied when regenerating your SDK, ensuring your documentation stays synchronized with the underlying implementation without requiring any changes to your existing integration code.