Merge pull request xolphin#10 from xolphin/XRS-228

XRS-228

Author: fukszssl247

CHANGELOG.md

@@ -1,6 +1,13 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
+## [1.7.0] - 2023-11-23
+### Added
+- approverRepresentative fields
+- added extra schedule_validation_call fields
+- added disable_free_san
+- added request cancel
+
 ## [1.6.0] - 2017-07-07
 ### Added
 - Compatability with Xolphin REST Api v1.6.0

README.rst

@@ -107,6 +107,18 @@ Send a "Comodo Subscriber Agreement" email
     result = client.request().send_ComodoSA(124, 'test@example.com')
     print(result.message);
 
+Request Callback (OV and EV certificates)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. code:: python
+
+    vc = client.request().configure_validation_call(order_id)
+    vc.date = "2024-01-26"
+    vc.time = "11:00"
+    vc.timezone = "Europe Amsterdam"
+    vc.phoneNumber = "132456789"
+    request = client.request().send_validation_call(vc);
+
 Certificate
 ~~~~~~~~~~~
 

examples/Request_create_EE.py

@@ -20,10 +20,11 @@
 RLuxVO9QX0YLQ0ew1x2z+eFfBsfSI1+DkF4+5TrfJP6jQyHBR+VDdGYBO2d8rBw7
 ITIJC9tt2F4GjaPAI1xY9eoq/QfZxzNoNufMuw==
 -----END CERTIFICATE REQUEST-----"""
-ccr.approver_first_name = 'FirstName'
-ccr.approver_last_name = 'LastName'
-ccr.approver_phone = '+12345678901'
-ccr.approver_email = 'email@domain.com'
+ccr.approver_representative_first_name = 'FirstName'
+ccr.approver_representative_last_name = 'LastName'
+ccr.approver_representative_phone = '+12345678901'
+ccr.approver_representative_email = 'email@domain.com'
+ccr.approver_representative_position = 'CTO'
 ccr.subject_alternative_names.append('test1.domain.com')
 ccr.subject_alternative_names.append('test2.domain.com')
 ccr.dcvType = 'DNS'

examples/Request_create_OV_ssl.py

@@ -0,0 +1,44 @@
+import xolphin
+client = xolphin.Client('youremail@domain.com', 'YourPassword', True);
+
+product = 147
+years = 1
+csr = """-----BEGIN CERTIFICATE REQUEST-----
+MIICszCCAZsCAQAwbjELMAkGA1UEBhMCR0IxDzANBgNVBAgMBkxvbmRvbjEPMA0G
+A1UEBwwGTG9uZG9uMRMwEQYDVQQKDApTU0wyNDcgTHRkMQswCQYDVQQLDAJJVDEb
+MBkGA1UEAwwSc3NsMjQ3LXRlc3RpbmcuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOC
+AQ8AMIIBCgKCAQEAwkpLdjQJohfnqBoNXCMTnsOaXfyz7a4nm3BNZhGF9I4fPdd9
+fuOZhOqIdy2tmQUp82rm9OjDtj9NjJHD3YRGLwTUJ2CJfCIaKescGAZYe8iNNyJ8
+Fuw/Jc2TD6UKgb/HyD9grqMQEPojD469ZA8ZYjAPax8UsilTdU5a8w0F+U6uF7Q+
+IMlo/OZ5pqewQTZ/fqPm/MoGiUYnMEnSzE9aVGUSjMov8nd/s/pEbM3Je7zg4aHX
+gFemBN5GY8vFQanZhSvGcIhhjdK3ac7Q5j5Y20sYmaORulvz0YH40ZYoml8KP8GO
+PKOlLhpKnade4u+kxo72Ws05cRtm4N78B5JLsQIDAQABoAAwDQYJKoZIhvcNAQEL
+BQADggEBADNQWLy+z8HdN3Xz0HJAPK6c5G7ukCAu/P8sYwNkWFnGGBrY7Uvl3XXF
+vSBMWS04AzylTn2qqHKuz5dIq68lgi0CTl1tR2Sp8/5vwCFZntJHGG6f/L/DRKcL
+Iriu7QW4mi5dQpDX6maJu/lE38XrcX/r2QdCkCWskiOdh+EnpwibdfT7sVqSrvDh
+Cgd0E7WtG1ecGB1QTpCsHBHMk604Pj/wDnw5SvNoX01dm8n3PY5/UfMFVrCnx2uT
+VDiArcp4X9/aZCiJxrf6UzY/7FH6qXYiP+hlIVqrqZ7Y3qaFQznBO3VWWNvuunXd
+1V2zpjfQjv+FuBDHyKUgX0Q4h3M9XTw=
+-----END CERTIFICATE REQUEST-----"""
+dcv_type = "DNS"
+
+
+ov_request = client.request().create(product,years,csr,dcv_type)
+
+ov_request.approver_representative_first_name = 'FirstName'
+ov_request.approver_representative_last_name = 'LastName'
+ov_request.approver_representative_position = 'Position'
+ov_request.approver_representative_phone = '+12345678901'
+ov_request.approver_representative_email = 'approver@emailaddress.com'
+ov_request.city = 'London'
+ov_request.zipcode = 'EC1R 0JH'
+ov_request.address = '3/11 Pine Street'
+ov_request.subject_alternative_names.append('test1.ssl247-testing.com')
+ov_request.subject_alternative_names.append('test2.ssl247-testing.com')
+ov_request.dcvType = 'DNS'
+
+#print(ov_request.toDict());
+
+request = client.request().send(ov_request)
+
+print(vars(request))

examples/Request_schedule_call.py

@@ -0,0 +1,80 @@
+import xolphin
+import json
+
+client = xolphin.Client('youremail@domain.com', 'YourPassword', True);
+
+order_id = 964178685
+date = "2024-01-26"
+time = "11:00"
+timezone = "Europe Amsterdam"
+
+#scheduling automated callback
+try:
+	vc = client.request().configure_validation_call(order_id)
+	vc.date = date
+	vc.time = time
+	vc.timezone = timezone
+	vc.phoneNumber = "132456789"
+	#vc.action = "ScheduledCallback" #not mandatory, this is the default action
+	request = client.request().send_validation_call(vc)
+	print(vars(request))
+except Exception as ex:
+	print("------- ERROR -------")
+	print(ex)
+
+#scheduling manual callback
+try:
+	vc = client.request().configure_validation_call(order_id)
+	vc.date = date
+	vc.time = time
+	vc.timezone = timezone
+	vc.phoneNumber = "132456789"
+	vc.extensionNumber = "123"
+	vc.action = "ManualCallback"
+	vc.commet = "Please ask for Joe"
+	request = client.request().send_validation_call(vc)
+	print(vars(request))
+except Exception as ex:
+	print("------- ERROR -------")
+	print(ex)
+
+
+#changing callback phone number
+try:
+	vc = client.request().configure_validation_call(order_id)
+	vc.date = date
+	vc.time = time
+	vc.timezone = timezone
+	vc.phoneNumber = "987654321"
+	vc.action = "ReplacePhone"
+	request = client.request().send_validation_call(vc)
+except Exception as ex:
+	print("------- ERROR -------")
+	print(ex)	
+
+#changing callback method from Telephone to Email
+try:
+	vc = client.request().configure_validation_call(order_id)
+	vc.date = date
+	vc.time = time
+	vc.timezone = timezone	
+	vc.action = "replaceEmailAddress"
+	vc.emailAddress = "youremail@domain.com"	
+	request = client.request().send_validation_call(vc)
+	print(vars(request))
+except Exception as ex:
+	print("------- ERROR -------")
+	print(ex)	
+
+#request re-sending callback email to customer
+try:
+	vc = client.request().configure_validation_call(order_id)
+	vc.date = date
+	vc.time = time
+	vc.action = "sendCallbackEmail"	
+	request = client.request().send_validation_call(vc)
+	print(vars(request))
+except Exception as ex:
+	print("------- ERROR -------")
+	print(ex)	
+

readme.md

@@ -59,10 +59,12 @@ print(request.product.brand)
 ```python
 ccr = client.request().create(24, 1, 'csr string', 'EMAIL')
 ccr.address = 'Address'
-ccr.approver_first_name = 'FirstName'
-ccr.approver_last_name = 'LastName'
-ccr.approver_phone = '+12345678901'
-ccr.approver_email = 'email@domain.com'
+ccr.approver_representative_first_name = 'FirstName'
+ccr.approver_representative_last_name = 'LastName'
+ccr.approver_representative_phone = '+12345678901'
+ccr.approver_representative_email = 'approver_email@domain.com'
+ccr.approver_representative_position = 'Pos'
+ccr.approver_email = 'admin@domain.com'
 ccr.zipcode = '123456'
 ccr.city = 'City'
 ccr.company = 'Company'
@@ -100,10 +102,12 @@ for note in result:
 ```python
 ccr = client.request().create_ee()
 ccr.csr = "<csr_string>"
-ccr.approver_first_name = 'FirstName'
-ccr.approver_last_name = 'LastName'
-ccr.approver_phone = '+12345678901'
-ccr.approver_email = 'email@domain.com'
+ccr.approver_representative_first_name = 'FirstName'
+ccr.approver_representative_last_name = 'LastName'
+ccr.approver_representative_phone = '+12345678901'
+ccr.approver_representative_email = 'approver_email@domain.com'
+ccr.approver_representative_position = 'Pos'
+ccr.approver_email = 'admin@domain.com'
 ccr.subject_alternative_names.append('test1.domain.com')
 ccr.subject_alternative_names.append('test2.domain.com')
 ccr.dcvType = 'DNS'
@@ -118,7 +122,16 @@ result = client.request().send_ComodoSA(124, 'test@example.com')
 print(result.message);
 ```
 
+#### Request Callback (OV and EV certificates)
 
+```python
+vc = client.request().configure_validation_call(order_id)
+vc.date = "2024-01-26"
+vc.time = "11:00"
+vc.timezone = "Europe Amsterdam"
+vc.phoneNumber = "132456789"
+request = client.request().send_validation_call(vc)
+```
 ### Certificate
 
 #### Certificates list and expirations

setup.py

@@ -12,7 +12,7 @@ def read(*paths):
 
 setup(
         name='xolphin-api',
-        version='1.6.0',
+        version='1.7.0',
         author='Xolphin',
         author_email='info@xolphin.com',
         license='MIT',

xolphin/__init__.py

@@ -4,7 +4,7 @@
 from __future__ import absolute_import
 
 __author__ = 'Xolphin'
-__version__ = '1.6.0'
+__version__ = '1.7.0'
 
 from .client import Client
 #from .errors import TwinglyException

xolphin/certificate_requests/configure_validation_call.py

@@ -0,0 +1,67 @@
+import json
+import warnings
+
+class ConfigureValidationCall(object):
+    def __init__(self, request_id):
+        self.request_id = request_id
+        self._action = "ScheduledCallback"
+        self._emailAddress = ""
+        self.date = ""
+        self.time = ""
+        self.timezone = ""
+        self.phoneNumber = ""
+        self.extensionNumber = ""
+        self.language = "en-us"
+        self.comments = ""
+
+    def toDict(self):
+        result = {
+            'request_id':self.request_id,
+            'action':self.action,
+            'date':self.date,
+            'time':self.time,
+            'timezone':self.timezone,
+            'phoneNumber':self.phoneNumber,
+            'extensionNumber':self.extensionNumber,
+            'emailAddress':self.emailAddress,
+            'language':self.language,
+            'comments':self.comments,
+        }
+        return result
+
+    @property
+    def action(self):
+        return self._action
+
+    @action.setter
+    def action(self,value):
+        actions = [ "ScheduledCallback", "ManualCallback", "ReplacePhone", "replaceEmailAddress","sendCallbackEmail"]
+        if(value not in actions):
+            raise Exception("Invalid action! Available actions: ScheduledCallback, ReplacePhone, replaceEmailAddress,sendCallbackEmail")
+
+        self._action = value
+    
+    @property
+    def language(self):
+        return self._action
+
+    @language.setter
+    def language(self,value):
+        languages = ['en-us', 'ru-ru', 'de-de', 'es-es', 'pt-br', 'nl-nl', 'fr-fr']
+        if(value not in languages):
+            raise Exception("Invalid languages! Available languages: 'en-us', 'ru-ru', 'de-de', 'es-es', 'pt-br', 'nl-nl', 'fr-fr'")
+
+        self._action = value        
+
+    @property
+    def emailAddress(self):
+        return self._emailAddress
+
+    @emailAddress.setter
+    def emailAddress(self,value):
+        import re
+        regex = r'\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\.[A-Z|a-z]{2,}\b'
+        if(re.fullmatch(regex, value) == None):
+            raise Exception("Invalid e-mail address")
+
+        self._emailAddress = value 

xolphin/certificate_requests/create_certificate_request.py

@@ -1,23 +1,31 @@
 import json
+import warnings
 
 class CreateCertificateRequest(object):
     def __init__(self, product, years, csr, dcv_type):
         self.product = product
         self.years = years
         self.csr = csr
         self.dcv_type = dcv_type
-
         self.subject_alternative_names = []
         self.dcv = []
         self.company = ''
         self.department = ''
         self.address = ''
         self.zipcode = ''
         self.city = ''
+        self.province = ''        
+        self.country = ''
+        self.certenroll_email = ''
         self.approver_first_name = ''
         self.approver_last_name = ''
         self.approver_email = ''
         self.approver_phone = ''
+        self.approver_representative_first_name = ''
+        self.approver_representative_last_name = ''
+        self.approver_representative_email = ''
+        self.approver_representative_phone = ''
+        self.approver_representative_position = ''
         self.kvk = ''
         self.reference = ''
         self.language = ''
@@ -40,12 +48,49 @@ def toDict(self):
         if self.address != '': result['address'] = self.address
         if self.zipcode != '': result['zipcode'] = self.zipcode
         if self.city != '': result['city'] = self.city
+        if self.province != '': result['province'] = self.province
+        if self.country != '': result['country'] = self.country
         if self.approver_first_name != '': result['approverFirstName'] = self.approver_first_name
         if self.approver_last_name != '': result['approverLastName'] = self.approver_last_name
         if self.approver_email != '': result['approverEmail'] = self.approver_email
         if self.approver_phone != '': result['approverPhone'] = self.approver_phone
+        if self.approver_representative_first_name != '': result['approverRepresentativeFirstName'] = self.approver_representative_first_name
+        if self.approver_representative_last_name != '': result['approverRepresentativeLastName'] = self.approver_representative_last_name
+        if self.approver_representative_email != '': result['approverRepresentativeEmail'] = self.approver_representative_email
+        if self.approver_representative_phone != '': result['approverRepresentativePhone'] = self.approver_representative_phone
+        if self.approver_representative_position != '': result['approverRepresentativePosition'] = self.approver_representative_position
+        if self.certenroll_email != '': result['certenrollEmail'] = self.certenroll_email
         if self.kvk != '': result['kvk'] = self.kvk
         if self.reference != '': result['reference'] = self.reference
         if self.language != '': result['language'] = self.language
 
         return result
+
+    @property        
+    def approver_first_name(self):
+        return self._approver_first_name
+    @property    
+    def approver_last_name(self):
+        return self._approver_last_name
+    @property    
+    def approver_phone(self):
+        return self._approver_phone
+
+
+    @approver_first_name.setter
+    def approver_first_name(self,value):
+        self._approver_first_name = value
+        if(value != ''):
+            warnings.warn("Warning! approverFirstName is deprecated, please use approverRepresentativeFirstName")
+
+    @approver_last_name.setter
+    def approver_last_name(self,value):
+        self._approver_last_name = value
+        if(value != ''):
+            warnings.warn("Warning! approverLastName is deprecated, please use approverRepresentativeLastName")
+
+    @approver_phone.setter
+    def approver_phone(self,value):
+        self._approver_phone = value
+        if(value != ''):
+            warnings.warn("Warning! approverPhone is deprecated, please use approverRepresentativePhone")