Enums are Iterators so when Entity.to_dict() is called, all possible values get serialized.

[aayushchhabra1999]

Describe the bug

PaddleStrEnum is implemented as an Iterator. So when to_dict is called on any instance of Entity (any class inheriting from Entity), all possible values of the enum field get serialized instead of serializing the current value of the enum in the instance.

The goal behavior should be serializing the current value of the field (which is exposed as to_json()) on the Enum.

The current workaround is that we have to loop through all the fields on any entity and manually call the to_json for Enum fields which defeats a large purpose of using the SDK.

Steps to reproduce

1. Call to_dict on a Subscription or SubscriptionCreated instance.
2. You will see all currency codes getting listed instead of the currency code of the instance.

Expected behavior

The goal behavior should be serializing the current value of the enum fields (which is exposed as to_json() on the Enum)

Code snippets

Python version

Python 3.11

SDK version

paddle-python-sdk 1.6.0

API version

Paddle Version 1

Additional context

[aayushchhabra1999]

This should be fixed with a custom as_dict method like this:

from dataclasses import _FIELDS, asdict, fields

def paddle_dataclass_as_dict(obj: any, dict_factory=dict) -> dict:  # noqa: ANN001
    """Convert an object to a dictionary."""
    if isinstance(obj, PaddleStrEnum):
        return obj.to_json()

    if hasattr(type(obj), _FIELDS):
        result = []
        for f in fields(obj):
            value = paddle_dataclass_as_dict(getattr(obj, f.name), dict)
            result.append((f.name, value))
        return dict(result)

    if isinstance(obj, tuple) and hasattr(obj, "_fields"):
        return type(obj)(*[paddle_dataclass_as_dict(v, dict_factory) for v in obj])
    if isinstance(obj, list | tuple):
        return type(obj)(paddle_dataclass_as_dict(v, dict_factory) for v in obj)
    if isinstance(obj, dict):
        return type(obj)(
            (
                paddle_dataclass_as_dict(k, dict_factory),
                paddle_dataclass_as_dict(v, dict_factory),
            )
            for k, v in obj.items()
        )
    return copy.deepcopy(obj)

[davidgrayston-paddle]

Hello @aayushchhabra1999 👋

Thank you for raising this issue, and also providing the code example that converts the SDK dataclasses to serialisable dictionaries.

The entities in the SDK can be JSON encoded using paddle_billing.Json.PayloadEncoder as follows:

from paddle_billing.Json import PayloadEncoder
from json import dumps

dumps(entity, cls=PayloadEncoder)

Whilst looking into this we did discover an issue with JSON encoding of undefined notification entities, that has been fixed in the latest release.

In the next major release, we will consider removing the enum iterator implementation to avoid the issue you are facing, and will also review the to_dict implementation on notification entities.