[FEAT]: Allow saving models to JSON? broken `to_json` method

[henrypost]

Is there an existing feature request for this?

• I have searched the existing feature requests

Description

Hello! I'm using your client and it rocks! The only issue is, I'm not sure how to serialize it to JSON.
I notice that your model classes extend DataClassJSONMixin, and have a to_json method, but I get an error when I execute that method because SnykClient tries to get serialized. Maybe you should implement a custom __getstate__ and __setstate__ or something for unpickleable attributes?

Example:

import os
import snyk
import json

class SnykClient:
    def __init__(self):
        self.client = snyk.SnykClient(os.environ.get('SNYK_API_KEY'))

    def get_all_projects(self):
        all_projects = self.client.projects.all()
        return all_projects

if __name__ == "__main__":
    client = SnykClient()
    all_projects = client.get_all_projects()
    print(all_projects)

    # save to json file
    with open('all_projects.json', 'w') as f:
        all_projects_jsonified = [project.to_json() for project in all_projects]
        json.dump(all_projects_jsonified, f)

Additional Information

No response

[henrypost]

Found one explanation!

https://github.com/snyk-labs/pysnyk/blob/aac24b2066a39e98864ec394f9149c6a076ff69c/snyk/models.py#L168C1-L169C1

Organization.client shouldn't be serialized. A custom __getitem__ method would probably fix this.

[henrypost]

Why does OrganizationManager.all() assign client to each org object? This also seems to be related to the issue. A data model shouldn't have a REST client object attached to it.

pysnyk/snyk/managers.py

Line 116 in aac24b2

org.client = self.client

[henrypost]

Here's another place where client is assigned a value that shouldn't live on a model object:

pysnyk/snyk/test_models.py

Line 19 in aac24b2

org.client = SnykClient("token")

[henrypost]

I've done some more digging and it looks like the model objects are used to manage client state quite a lot. The right solution would be to decouple this behavior and instead use a service layer to mess with client state instead of allowing model objects to do this...probably a lot of work. More than I can contribute at this time!

[henrypost]

In the meantime, I'm going to implement a class that wraps each model object and just does a custom to_dict method to avoid this fundamental issue. When I finish it, I'll post it here to improve this library a bit.