Metadata-Version: 2.4
Name: gocardless-events
Version: 0.1.3
Summary: Type-safe Python models for for all GoCardless events using Pydantic
Project-URL: Repository, https://github.com/karoo-ca/gocardless-events.git
Project-URL: Issues, https://github.com/karoo-ca/gocardless-events/issues
License: Copyright 2024 Karoo
        
        Permission is hereby granted, free of charge, to any person obtaining a copy of
        this software and associated documentation files (the “Software”), to deal in
        the Software without restriction, including without limitation the rights to
        use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
        the Software, and to permit persons to whom the Software is furnished to do so,
        subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
        FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
        COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
        IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
        CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
License-File: LICENSE
Keywords: gocardless,pydantic
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Typing :: Typed
Requires-Python: >=3.13
Requires-Dist: pydantic>=2.10.4
Description-Content-Type: text/markdown

# gocardless event schemas

> This is an unofficial library. GoCardless provide the [gocardless-pro python library](https://pypi.org/project/gocardless-pro/).
> The reason this exists is because that library is not typed.

Type-safe Python models for for all GoCardless events (using Pydantic).

This is a Python implementation of the Event Actions in the [GoCardless docs](https://developer.gocardless.com/api-reference#event-actions).

Since we only use Python 3.13+ this library doesn't support older versions, but
PRs are welcome.

## Why does this exist

GoCardless' docs are good, but they don't publish an OpenAPI spec or JSON schemas for
their events. Their Python client library is untyped, so deserialization of the events
is not type-safe.

## How it's made

We pulled all the event specs from the GoCardless docs site as HTML, cleaned
them, preproccessed them into a JSON pseudo-schema, and then generated Pydantic
models from that schema.
