Merge pull request #242 from plivo/SMS-6064

SMS-6064: Verify Python SDK

Author: narayana-plivo

CHANGELOG.md

@@ -1,12 +1,18 @@
 # Change Log
 
+## [4.41.0](https://github.com/plivo/plivo-python/tree/v4.41.0) (2023-08-10)
+**Feature - Verify**
+- Added Create Session API
+- Added Get Session API
+- Added List Session API
+- Added Validate Session API
+
 ## [4.40.0](https://github.com/plivo/plivo-python/tree/v4.40.0) (2023-08-07)
 
 **Feature - WhatsApp message support**
 - Added new param `template` and  new message_type `whatsapp` to [send message API](https://www.plivo.com/docs/sms/api/message#send-a-message)
 - Added  new  `message_states` (`read`)   `message_type`(`whatsapp`),`conversation_id`, `conversation_origin`,  `conversation_expiry_timestamp` in [list all messages API](https://www.plivo.com/docs/sms/api/message#list-all-messages) and [get message details API](https://www.plivo.com/docs/sms/api/message#retrieve-a-message) response
 
-
 ## [4.39.0](https://github.com/plivo/plivo-python/tree/v4.39.0) (2023-08-03)
 **Feature - DLT parameters**
 - Added new params `DLTEntityID`, `DLTTemplateID`, `DLTTemplateCategory` to the [send message API](https://www.plivo.com/docs/sms/api/message/send-a-message/)

plivo/base.py

@@ -60,6 +60,43 @@ def __repr__(self):
         return pprint.pformat(self.__dict__)
 
 
+class ListSessionResponseObject(ResponseObject):
+    def __init__(self, client, dct):
+        super(ListSessionResponseObject, self).__init__(dct)
+        self.error = dct.get('error', None)
+        self.sessions = dct.get('sessions', None)
+        self.meta = dct.get('meta', None)
+        self.apiID = dct.get('api_id', None)
+    def __iter__(self):
+        if self.sessions is not None:
+            return self.sessions.__iter__()
+        else:
+            return iter([])
+
+    def __len__(self):
+        if self.sessions is not None:
+            return len(self.sessions)
+        else:
+            return 0  # Return 0 for error case
+
+    def __str__(self):
+        if self.sessions is not None:
+            response_dict = {'api_id': self.apiID, 'meta': self.meta, 'sessions': self.sessions}
+            return pprint.pformat(response_dict)
+        else:
+            return str(self.error)  # Display error message for error case
+
+    def __repr__(self):
+        if self.sessions is not None:
+            response_dict = {'api_id': self.apiID, 'meta': self.meta, 'sessions': [session for session in self.sessions]}
+            return str(response_dict)
+        else:
+            return str(self.error)  # Display error message for error case
+
+    def has_error(self):
+        return self.error is not None
+
+
 class ListResponseObject(ResponseObject):
     def __init__(self, client, dct):
         super(ListResponseObject, self).__init__(dct)
@@ -243,4 +280,4 @@ def gen():
                     yield item
                 offset += limit
 
-        return gen()
+        return gen()

plivo/resources/__init__.py

@@ -20,3 +20,4 @@
 from .campaign import Campaign
 from .profile import Profile
 from .multipartycall import MultiPartyCalls, MultiPartyCall, MultiPartyCallParticipant
+from .verify import Sessions

plivo/resources/verify.py

@@ -0,0 +1,98 @@
+# -*- coding: utf-8 -*-
+from plivo.utils.validators import *
+
+from ..base import ListResponseObject, PlivoResource, PlivoResourceInterface, ListSessionResponseObject
+from ..exceptions import *
+from ..utils import *
+
+
+class Session(PlivoResource):
+    _name = 'Session'
+    _identifier_string = 'session_uuid'
+
+    def delete(self):
+        raise InvalidRequestError('Cannot delete a Session resource')
+
+    def update(self):
+        raise InvalidRequestError('Cannot update a Session resource')
+
+
+class Sessions(PlivoResourceInterface):
+    _resource_type = Session
+
+    @validate_args(
+        app_uuid=[optional(of_type(six.text_type))],
+        recipient=[required(is_phonenumber())],
+        channel=[optional(all_of(of_type(six.text_type), is_in(('sms', 'voice'))))],
+        url=[optional(is_url())],
+        method=[optional(of_type(six.text_type))])
+    def create(self,
+               app_uuid=None,
+               recipient=None,
+               channel=None,
+               url=None,
+               method='POST'):
+        if recipient is None:
+            raise ValidationError('destination number is required')
+        return self.client.request('POST', ('Verify', 'Session', ),
+                                   to_param_dict(self.create, locals()))
+
+    @validate_args(session_uuid=[of_type(six.text_type)])
+    def get(self, session_uuid):
+        return self.client.request(
+            'GET', ('Verify', 'Session', session_uuid), response_type=Session)
+
+    @validate_args(
+        subaccount=[optional(is_subaccount())],
+        status=[optional(is_in(('in-progress', 'expired', 'verified')))],
+        session_time__gt=[optional(is_valid_date())],
+        session_time__gte=[optional(is_valid_date())],
+        session_time__lt=[optional(is_valid_date())],
+        session_time__lte=[optional(is_valid_date())],
+        session_time=[optional(is_valid_date())],
+        country=[optional(of_type(six.text_type))],
+        alias=[optional(of_type(six.text_type))],
+        app_uuid=[optional(of_type(six.text_type))],
+        recipient=[optional(of_type(six.text_type))],
+        limit=[
+            optional(
+                all_of(
+                    of_type(*six.integer_types),
+                    check(lambda limit: 0 < limit <= 20, '0 < limit <= 20')))
+        ],
+        offset=[
+            optional(
+                all_of(
+                    of_type(*six.integer_types),
+                    check(lambda offset: 0 <= offset, '0 <= offset')))
+        ])
+    def list(self,
+             subaccount=None,
+             status=None,
+             session_time__gt=None,
+             session_time__gte=None,
+             session_time__lt=None,
+             session_time__lte=None,
+             session_time=None,
+             country=None,
+             alias=None,
+             app_uuid=None,
+             recipient=None,
+             limit=None,
+             offset=None):
+        return self.client.request(
+            'GET', ('Verify', 'Session', ),
+            to_param_dict(self.list, locals()),
+            response_type=ListSessionResponseObject,
+            objects_type=Session)
+
+    @validate_args(
+        otp=[optional(of_type(six.text_type))],
+        session_uuid=[of_type(six.text_type)]
+    )
+    def validate(self, session_uuid, otp=None):
+        if otp is None:
+            raise ValidationError('otp is required')
+        return self.client.request('POST', ('Verify', 'Session', session_uuid),
+                                   to_param_dict(self.validate, locals()))
+

plivo/rest/client.py

@@ -14,7 +14,7 @@
 from plivo.resources import (Accounts, Addresses, Applications, Calls,Token,
                              Conferences, Endpoints, Identities,
                              Messages, Powerpacks, Media, Lookup, Brand, Campaign, Profile,
-                             Numbers, Pricings, Recordings, Subaccounts, CallFeedback, MultiPartyCalls)
+                             Numbers, Pricings, Recordings, Subaccounts, CallFeedback, MultiPartyCalls, Sessions)
 from plivo.resources.live_calls import LiveCalls
 from plivo.resources.maskingsession import MaskingSessions
 from plivo.resources.profile import Profile
@@ -118,6 +118,7 @@ def __init__(self, auth_id=None, auth_token=None, proxies=None, timeout=5):
         self.multi_party_calls = MultiPartyCalls(self)
         self.masking_sessions = MaskingSessions(self)
         self.voice_retry_count = 0
+        self.verify_session = Sessions(self)
 
     def __enter__(self):
         return self

plivo/version.py

@@ -1,2 +1,2 @@
 # -*- coding: utf-8 -*-
-__version__ = '4.40.0'
+__version__ = '4.41.0'

tests/resources/__init__.py

@@ -14,4 +14,5 @@
 from .test_signature import *
 from .test_subaccounts import *
 from .test_brand import *
-from .test_campaign import *
+from .test_campaign import *
+from .test_verify import *

tests/resources/fixtures/sessionGetResponse.json

@@ -0,0 +1,30 @@
+{
+    "api_id": "8faf830c-4be8-485a-9235-045495b03148",
+    "session_uuid": "5c533d15-1975-4f20-80be-40174142ea37",
+    "app_uuid": "eeb90c7b-9367-4457-8644-47007661bff5",
+    "recipient": "918681951370",
+    "channel": "sms",
+    "status": "expired",
+    "count": 1,
+    "attempt_details": [
+        {
+            "channel": "sms",
+            "attempt_uuid": "c1ed6b11-783d-4efd-8b45-d372e02d2943",
+            "status": "failed",
+            "time": "2023-07-18T08:46:14.865388Z"
+        }
+    ],
+    "charges": {
+        "total_charge": "0",
+        "validation_charge": "0.0000",
+        "attempt_charges": [
+            {
+                "attempt_uuid": "c1ed6b11-783d-4efd-8b45-d372e02d2943",
+                "channel": "sms",
+                "charge": "0.00000"
+            }
+        ]
+    },
+    "created_at": "2023-07-18T08:46:14.851205Z",
+    "updated_at": "2023-07-18T08:46:14.865388Z"
+}