xolphin-api 1.8.0 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ea86464949998e7872f71f61ef5b469c35dfb068cec1ac3e21adb8fdfed6d94
-  data.tar.gz: b343eac1cdfd1560dbd838a380c81a83ad2ea224f225480f23a7cc95ce7a41f7
+  metadata.gz: 0b37e70b0b2c0f01661f2a47efffaeec51c13c537df04934e463fadc2551a45d
+  data.tar.gz: a90dc771d67d2a0f0dbdc7f265b6c86ff20ef80cf1416aee823fe7f06dde6af8
 SHA512:
-  metadata.gz: 7a8cddc0663d80351cd355641961950f7921ca0e130552d29436665b8f9f2f223d996cb16f5a50b5f69d86ac585a8e238b507241f2cdc7cbdcd7a9abd56fa0f0
-  data.tar.gz: '06923d52ba80d5a18019acf3f62e716bc34d0875ab2c6b3ba43650969c211cf428fca678d9fc351768d0e4519d4a2763401a3b817e1674737fb80372507bf029'
+  metadata.gz: d1bd2ac569ee9d8a7739b26eebf19b71a33dad0860798869fba44bb4faadfd0e01aad58f8f6a56efa07e493762738f34963cf2b0a1c3e3520d07897265b9fd41
+  data.tar.gz: cee4ebd929af45ac28d6c45d59ff9450defebc51842ff7cb200fd93287f4dd6052e9c6ca591b63bca64a5b5c2f3a89dbbe0658210975e20cdacaaf587723574f

data/examples/request_create.rb

@@ -0,0 +1,40 @@
+require_relative "../lib/xolphin/api"
+require_relative "_credentials.rb"
+
+client = Xolphin::Api::Client.new(Credentials.username, Credentials.password, true)
+csr = "-----BEGIN CERTIFICATE REQUEST-----
+MIICuDCCAaACADB0MQswCQYDVQQGEwJOTDEWMBQGA1UEAxMNd3d3LnNzbGRldi5u
+bDEWMBQGA1UEBxMNSGVlcmh1Z293YWFyZDEQMA4GA1UEChMHWG9scGhpbjEWMBQG
+A1UECBMNTm9vcmQtSG9sbGFuZDELMAkGA1UECxMCSVQwggEiMA0GCSqGSIb3DQEB
+AQUAA4IBDwAwggEKAoIBAQDkTFMNKhWObiUH1xDeRcqYiROKvJZEI7njDlQbXeVC
+qSaBSBClJD98OSgE0+arnVyJ5Fnjkovgb9aC8HbWYbiD1tbWD+hKC1wPODEvknl7
+jfRpO36cIglIhftHn5p0k+f86uS2Nz1yr+5qwAEQ7C0UQZxMuBbzK6Uv8m0TbAVV
+CQ+i+uJfuXSsAT8LZbyoJsu50ZySG3uEhCSISh1cS/t/M2INHbXfzGA3GWH2FXCZ
+Qd9eLSBAVEanIr3TlRpNU3f0IDwJpm56BVTNtNL7GI2NilfUF9oSo9PSlPbAkPsN
+BrVdOiZgiOEO74rXE8fjA5Zm8uic6MyFRo4FuTUBWubrAgMBAAGgADANBgkqhkiG
+9w0BAQsFAAOCAQEAHuB6643oI7oPw5SbFQAcfTfQbyRTXNqwYOO8YRcCkDIu7aX9
+pupGvf+cSa5IDcZ6Dz22/Khp5rYlcutAtEN7d8MNBwBlcVzbWL+DuTU5ZWAxcRi4
+nmiw/C+RxFF+WsUcjwb+dNrTYkz03t7voMg/0NS7RRU/oTu8heDDcH+Ffam1bZJQ
+zi21dz/AsjG9Jc6GJqZs0ImEwCQlBhJYnXPj3FB8U/mzSWSfq502fdtmQrvIgHmI
+RLuxVO9QX0YLQ0ew1x2z+eFfBsfSI1+DkF4+5TrfJP6jQyHBR+VDdGYBO2d8rBw7
+ITIJC9tt2F4GjaPAI1xY9eoq/QfZxzNoNufMuw==
+-----END CERTIFICATE REQUEST-----"
+request = client.request.create(145, 1, csr, 'EMAIL')
+
+
+request.approver_first_name = "OldFirstName"
+request.approver_last_name = "OldLastName"
+request.approver_phone = "Old+1234567890"
+request.approver_representative_first_name = "FirstName"
+request.approver_representative_last_name = "LastName"
+request.approver_representative_phone = "+1234567890"
+request.approver_representative_position = "CEO"
+request.approver_representative_email = 'approver@emailaddress.com'
+request.approver_email = "email@domain.com"
+request.approver_representative_email = "email@domain.com"
+request.address = "Exmouth House, 3 Pine St, London Ec1R 0Jh"
+request.zipcode = "Ec1R 0Jh"
+request.subject_alternative_names = ["test1.domain.com", "test2.domain.com"]
+request.dcv_type = "FILE"
+response = client.request.send(request)
+puts response.inspect

data/examples/request_get_id.rb

@@ -0,0 +1,6 @@
+require_relative "../lib/xolphin/api"
+require_relative "_credentials.rb"
+
+client = Xolphin::Api::Client.new(Credentials.username, Credentials.password, false)
+result = client.request.get(963437363)
+puts result.inspect

data/examples/request_validation_call.rb

@@ -1,5 +1,6 @@
 require_relative "../lib/xolphin/api"
+require_relative "_credentials.rb"
 
 client = Xolphin::Api::Client.new(Credentials.username, Credentials.password, true)
-result = client.request.scheduleValidationCall(960_002_992, "2017-05-01 13:00")
+result = client.request.scheduleValidationCall(963437377, "2024-01-01 13:00", {action: "ScheduledCallback"})
 puts result.inspect

data/examples/requests_get.rb

@@ -1,6 +1,7 @@
 require_relative "../lib/xolphin/api"
+require_relative "_credentials"
 
-client = Xolphin::Api::Client.new(Credentials.username, Credentials.password, true)
+client = Xolphin::Api::Client.new(Credentials.username, Credentials.password, false)
 requests = client.request.all
 requests.each do |request|
   puts request.id, request.product.id

data/lib/xolphin/api/certificate_requests/certificate_reissue.rb

@@ -7,7 +7,8 @@ module Xolphin
         attr_accessor :csr, :dcv_type, :subject_alternative_names, :dcv
         attr_accessor :company, :department, :address, :zipcode, :city, :kvk, :reference
         attr_accessor :approver_first_name, :approver_last_name, :approver_email, :approver_phone
-
+        attr_accessor :approver_representative_first_name, :approver_representative_last_name, :approver_representative_email, :approver_representative_phone, :approver_representative_position
+        
         def initialize(csr, dcv_type)
           @csr = csr
           @dcv_type = dcv_type
@@ -30,7 +31,13 @@ module Xolphin
             "approverFirstName" => @approver_first_name,
             "approverLastName" => @approver_last_name,
             "approverEmail" => @approver_email,
-            "approverPhone" => @approver_phone
+            "approverPhone" => @approver_phone,
+            # new validation variables
+            "approverRepresentativeFirstName" => @approver_representative_first_name, 
+            "approverRepresentativeLastName"  => @approver_representative_last_name,  
+            "approverRepresentativeEmail"  => @approver_representative_email,
+            "approverRepresentativePhone"  => @approver_representative_phone,
+            "approverRepresentativePosition"  => @approver_representative_position,
           }.reject { |_key, value| value.nil? })
 
           if @subject_alternative_names

data/lib/xolphin/api/certificate_requests/certificate_renew.rb

@@ -7,6 +7,7 @@ module Xolphin
         attr_accessor :product, :years, :csr, :dcv_type, :subject_alternative_names, :dcv
         attr_accessor :company, :department, :address, :zipcode, :city, :kvk, :reference
         attr_accessor :approver_first_name, :approver_last_name, :approver_email, :approver_phone
+        attr_accessor :approver_representative_first_name, :approver_representative_last_name, :approver_representative_email, :approver_representative_phone, :approver_representative_position
 
         def initialize(product, years, csr, dcv_type)
           @product = product
@@ -34,7 +35,13 @@ module Xolphin
             "approverFirstName" => @approver_first_name,
             "approverLastName" => @approver_last_name,
             "approverEmail" => @approver_email,
-            "approverPhone" => @approver_phone
+            "approverPhone" => @approver_phone,
+            # new validation variables
+            "approverRepresentativeFirstName" => @approver_representative_first_name, 
+            "approverRepresentativeLastName"  => @approver_representative_last_name,  
+            "approverRepresentativeEmail"  => @approver_representative_email,
+            "approverRepresentativePhone"  => @approver_representative_phone,
+            "approverRepresentativePosition"  => @approver_representative_position,
           }.reject { |_key, value| value.nil? })
 
           if @subject_alternative_names

data/lib/xolphin/api/certificate_requests/create_certificate_request.rb

@@ -7,6 +7,7 @@ module Xolphin
         attr_accessor :product, :years, :csr, :dcv_type, :subject_alternative_names, :dcv, :language
         attr_accessor :company, :department, :address, :zipcode, :city, :kvk, :reference, :referenceOrderNr
         attr_accessor :approver_first_name, :approver_last_name, :approver_email, :approver_phone
+        attr_accessor :approver_representative_first_name, :approver_representative_last_name, :approver_representative_email, :approver_representative_phone, :approver_representative_position
 
         def initialize(product, years, csr, dcv_type)
           @product = product
@@ -35,6 +36,11 @@ module Xolphin
             "approverLastName"  => @approver_last_name,
             "approverEmail"     => @approver_email,
             "approverPhone"     => @approver_phone,
+            "approverRepresentativeFirstName" => @approver_representative_first_name, 
+            "approverRepresentativeLastName"  => @approver_representative_last_name,  
+            "approverRepresentativeEmail"  => @approver_representative_email,
+            "approverRepresentativePhone"  => @approver_representative_phone,
+            "approverRepresentativePosition"  => @approver_representative_position,
             "language"          => @language,
             "referenceOrderNr"  => @referenceOrderNr
           }.reject { |_key, value| value.nil? })

data/lib/xolphin/api/endpoint/request.rb

@@ -3,9 +3,24 @@ require 'time'
 module Xolphin
   module Api
     module Endpoint
+      class RequestDeprecate
+        extend Gem::Deprecate
+
+        def initialize(http)
+          @http = http
+        end
+
+        def _send()
+        end
+        
+        deprecate :_send, 'The [approverFirstName, approverLastName, approverPhone] fields are deprecated please use [approverRepresentativeFirstName, approverRepresentativeLastName, approverRepresentativePhone].', 2023, 11
+      end
+
       class Request
+
         def initialize(http)
           @http = http
+          @deprecated = RequestDeprecate.new(@http)
         end
 
         def all
@@ -39,8 +54,15 @@ module Xolphin
         end
 
         def send(request)
-          result = @http.post("/requests", request.to_param)
+          requestParams = request.to_param
+          deprecatedFields = ["approverFirstName", "approverLastName", "approverPhone"]
+
+          if deprecatedFields.any? { |element| requestParams.include?(element) }
+            @deprecated._send()
+          end
 
+          result = @http.post("/requests", requestParams)
+          
           Xolphin::Api::Responses::Request.new(result)
         end
 
@@ -63,6 +85,15 @@ module Xolphin
 
           Xolphin::Api::Responses::Notes.new(result)
         end
+        
+        def scheduleValidationCall(id, date_time, extra = nil)
+          t = Time.parse(date_time)
+          params = { 'date' => t.strftime("%Y-%m-%d"), 'time' => t.strftime("%H:%M") }
+        
+          params.merge!(extra) if extra.is_a?(Hash)
+        
+          @http.post("requests/#{id}/schedule-validation-call", params)
+        end
 
         def sendComodoSAEmail(id, to, language = nil)
           @http.post("requests/#{id}/sa", 'sa_email' => to, 'language' => language)
@@ -72,11 +103,6 @@ module Xolphin
           @http.post("requests/#{id}/upload-document", 'document' => document, 'description' => description)
         end
 
-        def scheduleValidationCall(id, date_time)
-          t = Time.parse(date_time)
-          @http.post("requests/#{id}/schedule-validation-call", 'date' => t.strftime("%Y-%m-%d"), 'time' => t.strftime("%H:%M"))
-        end
-
         def retryDCV(id, domain, dcv_type, email = nil)
           @http.post("requests/#{id}/retry-dcv", "domain" => domain, "dcvType" => dcv_type, "email" => email)
         end

data/lib/xolphin/api/http.rb

@@ -18,8 +18,9 @@ module Xolphin
       def get(path, params = {})
         uri = URI.parse(File.join(api_url, path))
         uri.query = URI.encode_www_form(params) unless params.empty?
+        pkgver = Xolphin::Api::VERSION
 
-        request = Net::HTTP::Get.new(uri)
+        request = Net::HTTP::Get.new(uri, {'User-Agent' => "xolphin-api-ruby/#{pkgver}"})
         request.basic_auth(@username, @password)
 
         response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
@@ -31,8 +32,9 @@ module Xolphin
 
       def post(path, params = {})
         uri = URI.parse(File.join(api_url, path))
+        pkgver = Xolphin::Api::VERSION
 
-        request = Net::HTTP::Post.new(uri)
+        request = Net::HTTP::Post.new(uri, {'User-Agent' => "xolphin-api-ruby/#{pkgver}"})
         request.basic_auth(@username, @password)
         request.set_form_data(params)
 
@@ -46,8 +48,9 @@ module Xolphin
       def download(path, params = {})
         uri = URI.parse(File.join(api_url, path))
         uri.query = URI.encode_www_form(params) unless params.empty?
+        pkgver = Xolphin::Api::VERSION
 
-        request = Net::HTTP::Get.new(uri)
+        request = Net::HTTP::Get.new(uri, {'User-Agent' => "xolphin-api-ruby/#{pkgver}"})
         request.basic_auth(@username, @password)
 
         response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|

data/lib/xolphin/api/responses/request.rb

@@ -11,6 +11,10 @@ module Xolphin
         def id
           @data["id"]
         end
+        
+        def order_number
+          @data["orderNumber"]
+        end
 
         def domain_name
           @data["domainName"]
@@ -75,7 +79,26 @@ module Xolphin
         def approver_phone
           @data["approverPhone"]
         end
+        def approver_representative_first_name
+          @data["approverRepresentativeFirstName"]
+        end
 
+        def approver_representative_last_name
+          @data["approverRepresentativeLastName"]
+        end
+
+        def approver_representative_email
+          @data["approverRepresentativeEmail"]
+        end
+
+        def approver_representative_phone
+          @data["approverRepresentativePhone"]
+        end
+
+        def approver_position
+          @data["approverRepresentativePosition"]
+        end
+        
         def postbox
           @data["postbox"]
         end

data/lib/xolphin/api/version.rb

@@ -1,5 +1,5 @@
 module Xolphin
   module Api
-    VERSION = "1.8.0".freeze
+    VERSION = "1.9.0".freeze
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: xolphin-api
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 1.9.0
 platform: ruby
 authors:
 - Xolphin
@@ -78,7 +78,9 @@ files:
 - examples/certificate_renew.rb
 - examples/get_notes.rb
 - examples/invoices_get.rb
+- examples/request_create.rb
 - examples/request_create_ee.rb
+- examples/request_get_id.rb
 - examples/request_validation_call.rb
 - examples/requests_get.rb
 - examples/send_csa_email.rb