xolphin-api 1.5.0 → 1.9.0

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

@@ -1,33 +1,28 @@
-require 'json'
-
-module Xolphin
-  module Api
-    module CertificateRequests
-      class CreateEERequest
-        attr_accessor :csr, :dcv_type, :subject_alternative_names, :validate
-        attr_accessor :approver_first_name, :approver_last_name, :approver_email, :approver_phone
-
-        def to_param
-          result = {
-            "csr" => @csr,
-            "dcvType" => @dcv_type,
-            "approverFirstName" => @approver_first_name,
-            "approverLastName" => @approver_last_name,
-            "approverEmail" => @approver_email,
-            "approverPhone" => @approver_phone,
-          }
-
-          if @validate
-            result['validate'] = true;
-          end
-
-          if @subject_alternative_names
-            result["subjectAlternativeNames"] = @subject_alternative_names.join(",")
-          end
-
-          result
-        end
-      end
-    end
-  end
-end
+require 'json'
+
+module Xolphin
+  module Api
+    module CertificateRequests
+      class CreateEERequest
+        attr_accessor :csr, :dcv_type, :subject_alternative_names, :validate
+        attr_accessor :approver_first_name, :approver_last_name, :approver_email, :approver_phone
+
+        def to_param
+          result = {
+            "csr" => @csr,
+            "dcvType" => @dcv_type,
+            "approverFirstName" => @approver_first_name,
+            "approverLastName" => @approver_last_name,
+            "approverEmail" => @approver_email,
+            "approverPhone" => @approver_phone
+          }
+
+          result['validate'] = true if @validate
+          result["subjectAlternativeNames"] = @subject_alternative_names.join(",") if @subject_alternative_names
+
+          result
+        end
+      end
+    end
+  end
+end

data/lib/xolphin/api/client.rb

@@ -1,21 +1,25 @@
-module Xolphin
-  module Api
-    class Client
-      def initialize(username, password, test = false)
-        @http = Xolphin::Api::Http.new(username, password, test: test)
-      end
-
-      def request
-        Xolphin::Api::Endpoint::Request.new(@http)
-      end
-
-      def certificate
-        Xolphin::Api::Endpoint::Certificate.new(@http)
-      end
-
-      def support
-        Xolphin::Api::Endpoint::Support.new(@http)
-      end
-    end
-  end
-end
+module Xolphin
+  module Api
+    class Client
+      def initialize(username, password, test = false)
+        @http = Xolphin::Api::Http.new(username, password, test: test)
+      end
+
+      def request
+        Xolphin::Api::Endpoint::Request.new(@http)
+      end
+
+      def certificate
+        Xolphin::Api::Endpoint::Certificate.new(@http)
+      end
+
+      def support
+        Xolphin::Api::Endpoint::Support.new(@http)
+      end
+
+      def invoice
+        Xolphin::Api::Endpoint::Invoice.new(@http)
+      end
+    end
+  end
+end

data/lib/xolphin/api/dcv_type.rb

@@ -1,9 +1,9 @@
-module Xolphin
-  module Api
-    module DcvType
-      EMAIL = "EMAIL"
-      FILE = "FILE"
-      DNS = "DNS"
-    end
-  end
-end
+module Xolphin
+  module Api
+    module DcvType
+      EMAIL = "EMAIL"
+      FILE = "FILE"
+      DNS = "DNS"
+    end
+  end
+end

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

@@ -1,59 +1,59 @@
-module Xolphin
-  module Api
-    module Endpoint
-      class Certificate
-        def initialize(http)
-          @http = http
-        end
-
-        def all
-          certificates = []
-
-          result = @http.get("/certificates", page: 1)
-          response = Xolphin::Api::Responses::Certificates.new(result)
-
-          unless response.error?
-            certificates = response.certificates
-            while response.page < response.pages
-              result = @http.get("/certificates", page: response.page + 1)
-              response = Xolphin::Api::Responses::Certificates.new(result)
-              break if response.error?
-
-              certificates += response.certificates
-            end
-          end
-
-          certificates
-        end
-
-        def get(id)
-          result = @http.get("/certificates/#{id}")
-
-          Xolphin::Api::Responses::Certificate.new(result)
-        end
-
-        def download(id, format = Xolphin::Api::FormatType::CRT)
-          @http.download("/certificates/#{id}/download", format: format)
-        end
-
-        def reissue(id, request)
-          result = @http.post("/certificates/#{id}/reissue", request.to_param)
-          response = Xolphin::Api::Responses::Requests.new(result)
-        end
-
-        def renew(id, request)
-          result = @http.post("/certificates/#{id}/renew", request.to_param)
-          response = Xolphin::Api::Responses::Requests.new(result)
-        end
-
-        def cancel(id, reason, revoke = nil)
-          revoke ||= false
-          @http.post("/certificates/#{id}/cancel", [
-            'reason' => reason,
-            'revoke' => revoke
-          ])
-        end
-      end
-    end
-  end
-end
+module Xolphin
+  module Api
+    module Endpoint
+      class Certificate
+        def initialize(http)
+          @http = http
+        end
+
+        def all
+          certificates = []
+
+          result = @http.get("/certificates", page: 1)
+          response = Xolphin::Api::Responses::Certificates.new(result)
+
+          unless response.error?
+            certificates = response.certificates
+            while response.page < response.pages
+              result = @http.get("/certificates", page: response.page + 1)
+              response = Xolphin::Api::Responses::Certificates.new(result)
+              break if response.error?
+
+              certificates += response.certificates
+            end
+          end
+
+          certificates
+        end
+
+        def get(id)
+          result = @http.get("/certificates/#{id}")
+
+          Xolphin::Api::Responses::Certificate.new(result)
+        end
+
+        def download(id, format = Xolphin::Api::FormatType::CRT)
+          @http.download("/certificates/#{id}/download", format: format)
+        end
+
+        def reissue(id, request)
+          result = @http.post("/certificates/#{id}/reissue", request.to_param)
+          Xolphin::Api::Responses::Requests.new(result)
+        end
+
+        def renew(id, request)
+          result = @http.post("/certificates/#{id}/renew", request.to_param)
+          Xolphin::Api::Responses::Requests.new(result)
+        end
+
+        def cancel(id, reason, revoke = nil)
+          revoke ||= false
+          @http.post("/certificates/#{id}/cancel", [
+                       'reason' => reason,
+                       'revoke' => revoke
+                     ])
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+module Xolphin
+  module Api
+    module Endpoint
+      class Invoice
+        def initialize(http)
+          @http = http
+        end
+
+        def all
+          invoices = []
+
+          result = @http.get("/invoices", page: 1)
+          response = Xolphin::Api::Responses::Invoices.new(result)
+
+          unless response.error?
+            invoices = response.invoices
+            while response.page < response.pages
+              result = @http.get("/invoices", page: response.page + 1)
+              response = Xolphin::Api::Responses::Invoices.new(result)
+              break if response.error?
+
+              invoices += response.invoices
+            end
+          end
+
+          invoices
+        end
+
+        def get(id)
+          result = @http.get("/invoices/#{id}")
+          Xolphin::Api::Responses::Invoice.new(result)
+        end
+
+        def download(id, type = "PDF")
+          @http.download("/invoices/#{id}/download", type: type)
+        end
+      end
+    end
+  end
+end

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

@@ -1,86 +1,116 @@
-require 'time'
-
-module Xolphin
-  module Api
-    module Endpoint
-      class Request
-        def initialize(http)
-          @http = http
-        end
-
-        def all
-          requests = []
-
-          result = @http.get("/requests", page: 1)
-          response = Xolphin::Api::Responses::Requests.new(result)
-
-          unless response.error?
-            requests = response.requests
-            while response.page < response.pages
-              result = @http.get("/requests", page: response.page + 1)
-              response = Xolphin::Api::Responses::Requests.new(result)
-              break if response.error?
-
-              requests += response.requests
-            end
-          end
-
-          requests
-        end
-
-        def get(id)
-          result = @http.get("/requests/#{id}")
-
-          Xolphin::Api::Responses::Request.new(result)
-        end
-
-        def create(product, years, csr, dcv_type)
-          Xolphin::Api::CertificateRequests::CreateCertificateRequest.new(product, years, csr, dcv_type)
-        end
-
-        def send(request)
-          result = @http.post("/requests", request.to_param)
-
-          Xolphin::Api::Responses::Request.new(result)
-        end
-
-        def createEE()
-          Xolphin::Api::CertificateRequests::CreateEERequest.new()
-        end
-
-        def sendEE(request)
-          result = @http.post("/requests/ee", request.to_param)
-
-          Xolphin::Api::Responses::RequestEE.new(result)
-        end
-
-        def sendNote(id, note)
-          @http.post("/requests/#{id}/notes",{'message' => note})
-        end
-
-        def getNotes(id)
-          result = @http.get("/requests/#{id}/notes")
-          
-          Xolphin::Api::Responses::Notes.new(result)
-        end
-
-        def sendComodoSAEmail(id, to, language = nil)
-          @http.post("requests/#{id}/sa",{'sa_email' => to, 'language' => language})
-        end
-
-        def upload(id, document, description = nil)
-          @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
-      end
-    end
-  end
-end
+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
+          requests = []
+
+          result = @http.get("/requests", page: 1)
+          response = Xolphin::Api::Responses::Requests.new(result)
+
+          unless response.error?
+            requests = response.requests
+            while response.page < response.pages
+              result = @http.get("/requests", page: response.page + 1)
+              response = Xolphin::Api::Responses::Requests.new(result)
+              break if response.error?
+
+              requests += response.requests
+            end
+          end
+
+          requests
+        end
+
+        def get(id)
+          result = @http.get("/requests/#{id}")
+
+          Xolphin::Api::Responses::Request.new(result)
+        end
+
+        def create(product, years, csr, dcv_type)
+          Xolphin::Api::CertificateRequests::CreateCertificateRequest.new(product, years, csr, dcv_type)
+        end
+
+        def send(request)
+          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
+
+        def createEE
+          Xolphin::Api::CertificateRequests::CreateEERequest.new
+        end
+
+        def sendEE(request)
+          result = @http.post("/requests/ee", request.to_param)
+
+          Xolphin::Api::Responses::RequestEE.new(result)
+        end
+
+        def sendNote(id, note)
+          @http.post("/requests/#{id}/notes", 'message' => note)
+        end
+
+        def getNotes(id)
+          result = @http.get("/requests/#{id}/notes")
+
+          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)
+        end
+
+        def upload(id, document, description = nil)
+          @http.post("requests/#{id}/upload-document", 'document' => document, 'description' => description)
+        end
+
+        def retryDCV(id, domain, dcv_type, email = nil)
+          @http.post("requests/#{id}/retry-dcv", "domain" => domain, "dcvType" => dcv_type, "email" => email)
+        end
+
+        def cancel(id, reason = "")
+          @http.post("requests/#{id}/cancel", "reason" => reason)
+        end
+      end
+    end
+  end
+end

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

@@ -1,47 +1,47 @@
-module Xolphin
-  module Api
-    module Endpoint
-      class Support
-        def initialize(http)
-          @http = http
-        end
-
-        def products
-          products = []
-
-          result = @http.get("/products", page: 1)
-          response = Xolphin::Api::Responses::Products.new(result)
-
-          unless response.error?
-            products = response.products
-            while response.page < response.pages
-              result = @http.get("/products", page: response.page + 1)
-              response = Xolphin::Api::Responses::Products.new(result)
-              break if response.error?
-
-              products += response.products
-            end
-          end
-
-          products
-        end
-
-        def product(id)
-          result = @http.get("/products/#{id}")
-
-          Xolphin::Api::Responses::Product.new(result)
-        end
-
-        def decode_csr(csr)
-          result = @http.post("/decode-csr", csr: csr)
-
-          Xolphin::Api::Responses::CsrData.new(result)
-        end
-
-        def approver_email_addresses(domain)
-          @http.get("/approver-email-addresses", domain: domain)
-        end
-      end
-    end
-  end
-end
+module Xolphin
+  module Api
+    module Endpoint
+      class Support
+        def initialize(http)
+          @http = http
+        end
+
+        def products
+          products = []
+
+          result = @http.get("/products", page: 1)
+          response = Xolphin::Api::Responses::Products.new(result)
+
+          unless response.error?
+            products = response.products
+            while response.page < response.pages
+              result = @http.get("/products", page: response.page + 1)
+              response = Xolphin::Api::Responses::Products.new(result)
+              break if response.error?
+
+              products += response.products
+            end
+          end
+
+          products
+        end
+
+        def product(id)
+          result = @http.get("/products/#{id}")
+
+          Xolphin::Api::Responses::Product.new(result)
+        end
+
+        def decode_csr(csr)
+          result = @http.post("/decode-csr", csr: csr)
+
+          Xolphin::Api::Responses::CsrData.new(result)
+        end
+
+        def approver_email_addresses(domain)
+          @http.get("/approver-email-addresses", domain: domain)
+        end
+      end
+    end
+  end
+end

data/lib/xolphin/api/format_type.rb

@@ -1,12 +1,12 @@
-module Xolphin
-  module Api
-    module FormatType
-      CSR = "CSR"
-      CRT = "CRT"
-      ZIP = "ZIP"
-      PKCS7 = "PKCS7"
-      CA = "CA"
-      CA_BUNDLE = "CA_BUNDLE"
-    end
-  end
-end
+module Xolphin
+  module Api
+    module FormatType
+      CSR = "CSR"
+      CRT = "CRT"
+      ZIP = "ZIP"
+      PKCS7 = "PKCS7"
+      CA = "CA"
+      CA_BUNDLE = "CA_BUNDLE"
+    end
+  end
+end