Adding documentation for Hermes resources (#289)

* Adding docs

* version

* comments

* more comments

* fix dates

Author: chiqeen03

cuenca/resources/endpoints.py

@@ -19,6 +19,41 @@ class Endpoint(Creatable, Deactivable, Retrievable, Queryable, Updateable):
     is_enable: bool
     events: List[WebhookEvent]
 
+    class Config:
+        fields = {
+            'url': {'description': 'HTTPS url to send webhooks'},
+            'secret': {
+                'description': 'token to verify the webhook is sent by Cuenca '
+                'using HMAC algorithm'
+            },
+            'is_enable': {
+                'description': 'Allows user to turn-off the endpoint '
+                'without the need of deleting it'
+            },
+            'events': {
+                'description': 'list of enabled events. If None, '
+                'all events will be enabled for this Endpoint'
+            },
+        }
+        schema_extra = {
+            'example': {
+                '_id': 'ENxxne2Z5VSTKZm_w8Hzffcw',
+                'platform_id': 'PTZoPrrPT6Ts-9myamq5h1bA',
+                'created_at': '2022-06-29T22:00:00Z',
+                'updated_at': '2022-06-29T22:00:00Z',
+                'secret': '1234',
+                'url': 'https://webhook.site/714ed1d8',
+                'events': [
+                    'transaction.create',
+                    'transaction.update',
+                    'user.create',
+                    'user.update',
+                    'user.delete',
+                ],
+                'is_enable': True,
+            }
+        }
+
     @classmethod
     def create(
         cls,
@@ -30,7 +65,6 @@ def create(
         """
         Creates and Endpoint, allowing to recieve Webhooks with the specified
         events.
-
         :param url: HTTPS url to send webhooks
         :param events: list of enabled events. If None, all events will be
             enabled for this Endpoint
@@ -52,7 +86,6 @@ def update(
         """
         Updates endpoint properties. It allows reconfigure properties
         like url and is_active.
-
         :param endpoint_id: existing endpoint_id
         :param url
         :param is_enable

cuenca/resources/webhooks.py

@@ -10,3 +10,9 @@ class Webhook(Retrievable, Queryable):
 
     payload: Dict[str, Any]
     event: WebhookEvent
+
+    class Config:
+        fields = {
+            'payload': {'description': 'object sent by the webhook'},
+            'event': {'description': 'type of event being reported'},
+        }

cuenca/version.py

@@ -1,3 +1,3 @@
-__version__ = '0.13.4'
+__version__ = '0.13.5'
 CLIENT_VERSION = __version__
 API_VERSION = '2020-03-19'