Create platforms resource (#268)

* platforms

* lint

* fix

* init

* Fix

* reqs

* cov

* More fields for platforms

* v

* versions

* version and ctype change

* adding fields

* v

* version

* fields

* Lint

* version

* Fix

* version

* version

* empty

Author: chiqeen03

cuenca/__init__.py

@@ -20,6 +20,7 @@
     'KYCVerification',
     'LimitedWallet',
     'LoginToken',
+    'Platform',
     'Saving',
     'ServiceProvider',
     'Session',
@@ -61,6 +62,7 @@
     KYCVerification,
     LimitedWallet,
     LoginToken,
+    Platform,
     Saving,
     ServiceProvider,
     Session,

cuenca/resources/__init__.py

@@ -19,6 +19,7 @@
     'KYCVerification',
     'LimitedWallet',
     'LoginToken',
+    'Platform',
     'Saving',
     'ServiceProvider',
     'Session',
@@ -53,6 +54,7 @@
 from .kyc_verifications import KYCVerification
 from .limited_wallets import LimitedWallet
 from .login_tokens import LoginToken
+from .platforms import Platform
 from .resources import RESOURCES
 from .savings import Saving
 from .service_providers import ServiceProvider
@@ -103,6 +105,7 @@
     WalletTransaction,
     WhatsappTransfer,
     Webhook,
+    Platform,
 ]
 for resource_cls in resource_classes:
     RESOURCES[resource_cls._resource] = resource_cls  # type: ignore

cuenca/resources/platforms.py

@@ -0,0 +1,79 @@
+import datetime as dt
+from typing import ClassVar, Optional, cast
+
+from cuenca_validations.types import Country, PlatformRequest, State
+
+from ..http import Session, session as global_session
+from .base import Creatable
+
+
+class Platform(Creatable):
+    _resource: ClassVar = 'platforms'
+
+    created_at: dt.datetime
+    name: str
+    rfc_curp: Optional[str] = None
+    establishment_date: Optional[dt.date] = None
+    country: Optional[Country] = None
+    state: Optional[State] = None
+    economic_activity: Optional[str] = None
+    email_address: Optional[str] = None
+    phone_number: Optional[str] = None
+
+    class Config:
+        fields = {
+            'name': {'description': 'name of the platform being created'},
+            'rfc_curp': {'description': 'RFC or CURP of the platform'},
+            'establishment_date': {
+                'description': 'when the platform was established'
+            },
+            'country': {'description': 'country where the platform resides'},
+            'state': {'description': 'state where the platform resides'},
+            'economic_activity': {'description': 'what the platform does'},
+            'phone_number': {
+                'description': 'phone number to contact the platform'
+            },
+            'email_address': {
+                'description': 'email address to contact the platform'
+            },
+        }
+        schema_extra = {
+            'example': {
+                'id': 'PT0123456789',
+                'name': 'Arteria',
+                'created_at': '2021-08-24T14:15:22Z',
+                'rfc_curp': 'ART123456FFF',
+                'establishment_date': '2021-08-24T14:15:22Z',
+                'country': 'MX',
+                'state': 'DF',
+                'economic_activity': 'fiinances and technologies',
+                'phone_number': '+525555555555',
+                'email_address': 'art@eria.com',
+            }
+        }
+
+    @classmethod
+    def create(
+        cls,
+        name: str,
+        rfc_curp: Optional[str] = None,
+        establishment_date: Optional[str] = None,
+        country: Optional[Country] = None,
+        state: Optional[State] = None,
+        economic_activity: Optional[str] = None,
+        phone_number: Optional[str] = None,
+        email_address: Optional[str] = None,
+        *,
+        session: Session = global_session,
+    ) -> 'Platform':
+        req = PlatformRequest(
+            name=name,
+            rfc_curp=rfc_curp,
+            establishment_date=establishment_date,
+            country=country,
+            state=state,
+            economic_activity=economic_activity,
+            phone_number=phone_number,
+            email_address=email_address,
+        )
+        return cast('Platform', cls._create(session=session, **req.dict()))

cuenca/version.py

@@ -1,3 +1,3 @@
-__version__ = '0.10.1'
+__version__ = '0.11.0'
 CLIENT_VERSION = __version__
 API_VERSION = '2020-03-19'

requirements.txt

@@ -1,3 +1,3 @@
 requests==2.27.1
-cuenca-validations==0.10.9
+cuenca-validations==0.10.10
 dataclasses>=0.7;python_version<"3.7"

tests/resources/cassettes/test_platforms_create.yaml

@@ -0,0 +1,54 @@
+interactions:
+- request:
+    body: '{"name": "Test"}'
+    headers:
+      Accept:
+      - '*/*'
+      Accept-Encoding:
+      - gzip, deflate
+      Authorization:
+      - DUMMY
+      Connection:
+      - keep-alive
+      Content-Length:
+      - '16'
+      Content-Type:
+      - application/json
+      User-Agent:
+      - cuenca-python/0.10.1.dev2
+      X-Cuenca-Api-Version:
+      - '2020-03-19'
+      X-Cuenca-LoginId:
+      - ULev1mLmNST6ie3wcket7c-w
+    method: POST
+    uri: https://sandbox.cuenca.com/platforms
+  response:
+    body:
+      string: '{"id":"PTE_7V8Wj2Rau85dTgtlgG8w","created_at":"2022-06-02T23:42:25.491767","name":"Test"}'
+    headers:
+      Connection:
+      - keep-alive
+      Content-Length:
+      - '89'
+      Content-Type:
+      - application/json
+      Date:
+      - Thu, 02 Jun 2022 23:42:25 GMT
+      X-Request-Time:
+      - 'value: 0.447'
+      x-amz-apigw-id:
+      - THijNFxtIAMFTpA=
+      x-amzn-Remapped-Connection:
+      - keep-alive
+      x-amzn-Remapped-Content-Length:
+      - '89'
+      x-amzn-Remapped-Date:
+      - Thu, 02 Jun 2022 23:42:25 GMT
+      x-amzn-Remapped-Server:
+      - nginx/1.22.0
+      x-amzn-RequestId:
+      - 506fba75-65ae-4d29-896d-8f5838835721
+    status:
+      code: 201
+      message: Created
+version: 1

tests/resources/test_platforms.py

@@ -0,0 +1,10 @@
+import pytest
+
+from cuenca.resources import Platform
+
+
+@pytest.mark.vcr
+def test_platforms_create() -> None:
+    platform = Platform.create(name='Test')
+    assert platform.id
+    assert platform.name == 'Test'