Skip to content

🎉 Digistore24 API Client v2.0.0

Choose a tag to compare

View all tags
@PaulGossen PaulGossen released this 08 Nov 13:49
· 52 commits to main since this release
v2.0.0
2b04f2e

Major Release - Complete rewrite with PHP 8.4 property hooks, modern architecture, and extensive quality improvements.

🚀 Highlights

PHP 8.4 Property Hooks

Automatic validation on property assignment - no more boilerplate constructors:

$buyer = new BuyerData();
$buyer->email = 'test@example.com';  // ✅ Auto-validated
$buyer->country = 'de';              // ✅ Auto-uppercased to 'DE'

Cleaner API Calls

Methods with optional parameters no longer require explicit Request objects:

// v1.x - Always needed Request object
$products = $ds24->products->list(new ListProductsRequest());

// v2.0 - Much cleaner!
$products = $ds24->products->list();

Enterprise-Grade Quality

  • ✅ 1,130 passing unit tests (100% success rate)
  • ✅ PHPStan Level 9 (maximum strictness) - 0 errors
  • ✅ 98% code coverage (lines), 99% functions, 100% classes
  • ✅ 85%+ mutation score (test quality validation)
  • ✅ PSR-12 compliant (0 code style violations)

Complete API Coverage

  • ✅ 122 endpoints fully implemented
  • ✅ 12 resource categories (Affiliates, Products, Purchases, etc.)
  • ✅ Comprehensive documentation for every endpoint

💥 Breaking Changes

1. Namespace Change

// OLD
use GoSuccess\Digistore24\Digistore24;

// NEW
use GoSuccess\Digistore24\Api\Digistore24;

2. Constructor Signature

// OLD
$ds24 = new Digistore24(apiKey: 'YOUR-KEY');

// NEW
$config = new Configuration(apiKey: 'YOUR-KEY');
$ds24 = new Digistore24($config);

3. PHP Version Requirement

  • Minimum PHP 8.4.0 (required for property hooks)

📖 Full migration guide: See MIGRATION.md

✨ What's New

Architecture & Quality

  • 🏗️ Resource-based architecture with clean separation of concerns
  • 🎯 Type-safe - Full type hints, enums, and strict typing throughout
  • 🔄 Automatic retry - Built-in exponential backoff for failed requests
  • 🚦 Rate limiting - Graceful handling of API rate limits
  • 📝 Fully documented - Comprehensive PHPDoc with examples

Developer Experience

  • ✅ GitHub Actions CI/CD - Automated testing, static analysis, code style checks
  • ✅ PHPStan Level 9 - Maximum type safety with baseline tracking
  • ✅ PHP CS Fixer - PSR-12 + PHP 8.4 rules enforced
  • ✅ Infection - Mutation testing for test quality validation
  • ✅ Dependabot - Automated dependency updates

Documentation

  • 📚 122 endpoint docs organized in 29 categories
  • 📖 Migration guide with find-replace instructions
  • 🧪 Testing guide with coverage setup
  • 🛠️ Developer setup with IDE configuration
  • 📋 Changelog with complete version history
  • 🔒 Security policy with vulnerability reporting

New Features

  • 🎉 Optional Request parameters - 39+ methods across 27 Resources
  • 🎨 15 typed DTOs with property hooks (BuyerData, PaymentPlanData, etc.)
  • 🔧 Configuration object - Centralized config with validation
  • ⚡ Lazy loading - Resources initialized on-demand

📦 Installation

# Fresh install
composer require gosuccess/digistore24-api

# Upgrade from v1.x
composer remove gosuccess/php-ds24-api-wrapper
composer require gosuccess/digistore24-api

🎯 Quick Start

use GoSuccess\Digistore24\Api\Digistore24;
use GoSuccess\Digistore24\Api\Client\Configuration;

// Initialize
$config = new Configuration(apiKey: 'YOUR-API-KEY');
$ds24 = new Digistore24($config);

// Simple calls (no Request object needed)
$products = $ds24->products->list();
$userInfo = $ds24->users->getInfo();
$ping = $ds24->monitoring->ping();

// Advanced calls (with Request object for filters)
$purchases = $ds24->purchases->list(
    new ListPurchasesRequest(
        fromDate: new DateTime('-7 days'),
        toDate: new DateTime('now')
    )
);

📊 Quality Metrics

Metric Value Status
Unit Tests 1,130 passing ✅ 100%
Assertions 2,227 ✅
Code Coverage Lines ~98%, Functions ~99% ✅
Mutation Score 85%+ MSI ✅
PHPStan Level 9 (max) ✅ 0 errors
Code Style PSR-12 ✅ 0 violations
Endpoints 122 implemented ✅ 100%

🔧 Infrastructure

GitHub Actions Workflows

  • ✅ Tests - PHPUnit with coverage reporting
  • ✅ Static Analysis - PHPStan Level 9
  • ✅ Code Style - PHP CS Fixer with PSR-12

Composer Scripts

composer test              # Run all tests
composer test:coverage     # Coverage report
composer analyse           # PHPStan analysis
composer cs:check          # Code style check
composer cs:fix            # Auto-fix code style
composer check             # All quality checks

Dependency Management

  • 🤖 Dependabot - Weekly Composer updates, monthly GitHub Actions
  • 📦 Automated PRs - Security and version updates

🛠️ API Resources

Resource Endpoints Documentation
Affiliates 8 Commission management
Billing 3 Invoicing & payments
Buyers 8 Customer information
Buy URLs 3 Order form management
Countries 2 Country & currency data
IPNs 3 Webhook management
Monitoring 1 Health checks
Products 59 Product management
Purchases 24 Order information
Rebilling 4 Subscription management
Users 3 Authentication & settings
Vouchers 6 Discount codes

Total: 122 endpoints across 12 resource categories

📚 Documentation

🙏 Thank You

Special thanks to all contributors who helped make v2.0 possible! This release represents months of refactoring, testing, and quality improvements.

🐛 Found a Bug?

Report issues: https://github.com/GoSuccessHQ/digistore24-api/issues

📄 License

MIT License - see LICENSE

Full Changelog: https://github.com/GoSuccessHQ/digistore24-api/blob/main/docs/CHANGELOG.md

Assets 2
Loading