conversant 1.0.16

data/lib/conversant/v3/services/cdn/audit.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module Conversant
+  module V3
+    module Services
+      class CDN
+        # Audit service for CDN activity logging
+        #
+        # Provides access to audit logs and compliance tracking
+        # for CDN configuration changes and administrative actions.
+        #
+        # @example View audit logs
+        #   cdn = Conversant::V3.cdn(12345)
+        #
+        #   logs = cdn.audit.list({
+        #     startTime: "2025-01-01T00:00:00Z",
+        #     endTime: "2025-01-01T23:59:59Z",
+        #     pageSize: 100,
+        #     pageNumber: 0
+        #   })
+        #
+        #   logs.each do |log|
+        #     puts "#{log['timestamp']}: #{log['action']} by #{log['user']}"
+        #   end
+        #
+        # @since 1.0.0
+        class Audit
+          # @return [CDN] the parent CDN service instance
+          attr_reader :parent
+
+          # Initialize audit service
+          #
+          # @param parent [CDN] the parent CDN service instance
+          def initialize(parent)
+            @parent = parent
+          end
+
+          # Get audit log entries
+          #
+          # @param payload [Hash] audit query parameters
+          # @option payload [String] :startTime start time for audit logs
+          # @option payload [String] :endTime end time for audit logs
+          # @option payload [String] :action specific action to filter by
+          # @option payload [String] :user user ID to filter by
+          # @option payload [Integer] :pageSize number of results per page
+          # @option payload [Integer] :pageNumber page number (0-based)
+          #
+          # @return [Array] array of audit log entries, or empty array on error
+          #
+          # @example Get recent audit logs
+          #   logs = cdn.audit.list({
+          #     startTime: "2025-01-01T00:00:00Z",
+          #     endTime: "2025-01-01T23:59:59Z",
+          #     pageSize: 100,
+          #     pageNumber: 0
+          #   })
+          #   logs.each { |log| puts "#{log['timestamp']}: #{log['action']} by #{log['user']}" }
+          #
+          # @since 1.0.0
+          def list(payload)
+            response = JSON.parse(@parent.send(:call, 'POST', '/api/audit_list', payload))
+            response&.[]('list') || []
+          rescue StandardError => e
+            @parent.send(:logger).error "#{@parent.send(:identifier)}.METHOD:#{__method__}.EXCEPTION:#{e.message}"
+            []
+          end
+        end
+      end
+    end
+  end
+end

data/lib/conversant/v3/services/cdn/business.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+module Conversant
+  module V3
+    module Services
+      class CDN
+        # Business metrics service for CDN billing and usage reporting
+        #
+        # Provides access to business-level metrics used for billing calculations,
+        # usage reporting, and 95th percentile bandwidth measurements.
+        # These metrics are typically used for financial reporting and capacity planning.
+        #
+        # @example Get billing metrics
+        #   business = cdn.business
+        #
+        #   # Get traffic usage for billing
+        #   usage = business.bandwidth({
+        #     startTime: "2025-01-01T00:00:00Z",
+        #     endTime: "2025-01-31T23:59:59Z",
+        #     pageSize: 1000,
+        #     pageNumber: 0
+        #   })
+        #
+        #   # Get 95th percentile bandwidth
+        #   bandwidth_95th = business.bandwidth95th(year: 2025)
+        #
+        # @since 1.0.1
+        class Business
+          # @return [CDN] the parent CDN service instance
+          attr_reader :parent
+
+          # Initialize business metrics service
+          #
+          # @param parent [CDN] the parent CDN service instance
+          def initialize(parent)
+            @parent = parent
+          end
+
+          # Get domain traffic usage for billing
+          #
+          # Retrieves detailed traffic usage data by domain for billing and reporting purposes.
+          # This data is typically used for invoicing and usage analysis.
+          #
+          # @param payload [Hash] query parameters for traffic usage
+          # @option payload [String] :startTime start time in ISO 8601 format ("2025-01-01T00:00:00Z")
+          # @option payload [String] :endTime end time in ISO 8601 format ("2025-01-31T23:59:59Z")
+          # @option payload [Integer] :pageSize number of results per page (recommended: 1000)
+          # @option payload [Integer] :pageNumber page number for pagination (0-based)
+          #
+          # @return [Array, Array] array of domain traffic usage records, or empty array on error
+          #
+          # @example Get monthly traffic usage
+          #   usage = cdn.business.bandwidth({
+          #     startTime: "2025-01-01T00:00:00Z",
+          #     endTime: "2025-01-31T23:59:59Z",
+          #     pageSize: 1000,
+          #     pageNumber: 0
+          #   })
+          #
+          #   usage.each do |record|
+          #     puts "Domain: #{record['domain']}"
+          #     puts "Traffic: #{record['traffic_bytes']} bytes"
+          #     puts "Period: #{record['period']}"
+          #   end
+          #
+          # @since 1.0.1
+          def bandwidth(payload)
+            response = @parent.send(:call, 'POST', '/api/domain_traffic_usage', payload)
+            return [] if response.nil?
+
+            JSON.parse(response)&.[]('list') || []
+          rescue StandardError => e
+            logger.error "#{@parent.send(:identifier)}.METHOD:#{__method__}.EXCEPTION:#{e.message}"
+            []
+          end
+
+          # Get 95th percentile bandwidth measurements
+          #
+          # Retrieves 95th percentile bandwidth measurements for the specified year.
+          # This metric is commonly used in CDN billing to calculate peak usage
+          # while excluding traffic spikes that occur less than 5% of the time.
+          #
+          # @param params [Hash] query parameters
+          # @option params [Integer] :year the year to get 95th percentile data for (e.g., 2025)
+          #
+          # @return [Array, Array] array of 95th percentile bandwidth measurements, or empty array on error
+          #
+          # @example Get 95th percentile for current year
+          #   bandwidth_95th = cdn.business.bandwidth95th(year: 2025)
+          #
+          #   bandwidth_95th.each do |measurement|
+          #     puts "Month: #{measurement['month']}"
+          #     puts "95th Percentile: #{measurement['bandwidth_95th']} bps"
+          #     puts "Peak: #{measurement['peak_bandwidth']} bps"
+          #   end
+          #
+          # @example Calculate annual 95th percentile
+          #   measurements = cdn.business.bandwidth95th(year: 2025)
+          #   annual_95th = measurements.map { |m| m['bandwidth_95th'] }.max
+          #   puts "Annual 95th percentile: #{annual_95th} bps"
+          #
+          # @since 1.0.1
+          def bandwidth95th(params)
+            response = @parent.send(:call, 'GET', "/api/report/bandwidth95th/#{params[:year]}", nil)
+            return [] if response.nil?
+
+            JSON.parse(response)
+          rescue StandardError => e
+            logger.error "#{@parent.send(:identifier)}.METHOD:#{__method__}.EXCEPTION:#{e.message}"
+            []
+          end
+
+          private
+
+          def logger
+            @parent.send(:logger)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/conversant/v3/services/cdn/certificate.rb

@@ -0,0 +1,180 @@
+# frozen_string_literal: true
+
+module Conversant
+  module V3
+    module Services
+      class CDN
+        # SSL/TLS certificate management service for CDN domains
+        #
+        # Provides comprehensive certificate management functionality including:
+        # - Certificate listing and filtering
+        # - Auto-certificate information retrieval
+        # - Automatic certificate deployment
+        # - Let's Encrypt integration support
+        #
+        # @example Basic certificate operations
+        #   certificates = cdn.certificate.all
+        #   cert_info = cdn.certificate.auto_certificate_info(cert_id, domain_name)
+        #
+        #   # Deploy auto certificate
+        #   success = cdn.certificate.deploy_auto_certificate(cert_id, domain_name, {
+        #     enable: true,
+        #     domains: ["example.com", "www.example.com"]
+        #   })
+        #
+        # @since 1.0.1
+        class Certificate
+          # @return [CDN] the parent CDN service instance
+          attr_reader :parent
+
+          # Initialize certificate service
+          #
+          # @param parent [CDN] the parent CDN service instance
+          def initialize(parent)
+            @parent = parent
+          end
+
+          # Get all SSL certificates for the customer
+          #
+          # Retrieves a comprehensive list of SSL certificates associated with the customer account.
+          # Supports filtering and pagination through query parameters.
+          #
+          # @param params [Hash] optional query parameters for filtering and pagination
+          # @option params [Integer] :pageSize number of results per page
+          # @option params [Integer] :pageNumber page number for pagination (0-based)
+          # @option params [String] :status filter by certificate status (active, expired, pending)
+          # @option params [String] :domain filter by domain name
+          #
+          # @return [Array<Hash>, Array] array of certificate objects with properties like id, name, status, expiry, etc.
+          #   Returns empty array on error or if no certificates exist.
+          #
+          # @example Get all certificates
+          #   certificates = cdn.certificate.all
+          #   certificates.each do |cert|
+          #     puts "Certificate: #{cert['name']} (ID: #{cert['id']})"
+          #     puts "  Status: #{cert['status']}"
+          #     puts "  Expires: #{cert['expiry_date']}"
+          #     puts "  Domains: #{cert['domains']&.join(', ')}"
+          #   end
+          #
+          # @example Get certificates with pagination
+          #   certificates = cdn.certificate.all({
+          #     pageSize: 50,
+          #     pageNumber: 0,
+          #     status: "active"
+          #   })
+          #
+          # @since 1.0.1
+          def all(params = {})
+            response = @parent.send(:call, 'GET', "/list-certificate?#{params.to_query}")
+            return [] if response.nil?
+
+            JSON.parse(response)&.[]('list') || []
+          rescue StandardError => e
+            logger.error "#{@parent.send(:identifier)}.METHOD:#{__method__}.EXCEPTION:#{e.message}"
+            []
+          end
+
+          # Get auto-certificate information for a specific domain
+          #
+          # Retrieves detailed information about an auto-certificate (Let's Encrypt) for a specific
+          # certificate ID and domain name. This includes certificate status, validation details,
+          # and deployment configuration.
+          #
+          # @param certificate_id [Integer, String] the certificate ID to query
+          # @param name [String] the domain name to get certificate info for
+          #
+          # @return [Hash, nil] certificate information hash containing status, domains, validation details, etc.
+          #   Returns nil on error or if certificate doesn't exist.
+          #
+          # @example Get auto-certificate info
+          #   cert_info = cdn.certificate.auto_certificate_info(12345, "example.com")
+          #   if cert_info
+          #     puts "Certificate Status: #{cert_info['status']}"
+          #     puts "Validation Method: #{cert_info['validation_method']}"
+          #     puts "Domains: #{cert_info['domains']&.join(', ')}"
+          #     puts "Auto-renewal: #{cert_info['auto_renewal'] ? 'Enabled' : 'Disabled'}"
+          #   else
+          #     puts "Certificate not found or error occurred"
+          #   end
+          #
+          # @example Check certificate validation status
+          #   cert_info = cdn.certificate.auto_certificate_info(cert_id, domain)
+          #   if cert_info && cert_info['validation_status'] == 'valid'
+          #     puts "Certificate is valid and ready for deployment"
+          #   end
+          #
+          # @since 1.0.1
+          def auto_certificate_info(certificate_id, name)
+            response = @parent.send(:call, 'GET', "/api/auto-certificate/#{certificate_id}/#{name}")
+            return nil if response.nil?
+
+            JSON.parse(response)
+          rescue StandardError => e
+            logger.error "#{@parent.send(:identifier)}.METHOD:#{__method__}.EXCEPTION:#{e.message}"
+            nil
+          end
+
+          # Deploy auto-certificate for a domain
+          #
+          # Deploys or updates an auto-certificate (Let's Encrypt) configuration for the specified
+          # certificate ID and domain. This enables automatic SSL certificate provisioning and renewal.
+          #
+          # @param certificate_id [Integer, String] the certificate ID to deploy
+          # @param name [String] the primary domain name for the certificate
+          # @param payload [Hash] deployment configuration
+          # @option payload [Boolean] :enable enable auto-certificate for this domain
+          # @option payload [Array<String>] :domains list of domains to include in the certificate
+          # @option payload [String] :validation_method validation method (dns, http, etc.)
+          # @option payload [Boolean] :auto_renewal enable automatic certificate renewal
+          # @option payload [Hash] :dns_settings DNS validation settings (if using DNS validation)
+          #
+          # @return [Boolean] true if deployment was successful, false otherwise
+          #
+          # @example Deploy auto-certificate for single domain
+          #   success = cdn.certificate.deploy_auto_certificate(12345, "example.com", {
+          #     enable: true,
+          #     domains: ["example.com"],
+          #     validation_method: "http",
+          #     auto_renewal: true
+          #   })
+          #
+          #   if success
+          #     puts "Auto-certificate deployed successfully"
+          #   else
+          #     puts "Failed to deploy auto-certificate"
+          #   end
+          #
+          # @example Deploy auto-certificate for multiple domains
+          #   success = cdn.certificate.deploy_auto_certificate(cert_id, "example.com", {
+          #     enable: true,
+          #     domains: ["example.com", "www.example.com", "api.example.com"],
+          #     validation_method: "dns",
+          #     auto_renewal: true,
+          #     dns_settings: {
+          #       provider: "cloudflare",
+          #       api_token: "your_api_token"
+          #     }
+          #   })
+          #
+          # @since 1.0.1
+          def deploy_auto_certificate(certificate_id, name, payload)
+            response = @parent.send(:call, 'POST', "/api/auto-certificate/#{certificate_id}/#{name}", payload)
+            return false if response.nil?
+
+            JSON.parse(response)&.[]('status') == 'ok'
+          rescue StandardError => e
+            logger.error "#{@parent.send(:identifier)}.METHOD:#{__method__}.EXCEPTION:#{e.message}"
+            false
+          end
+
+          private
+
+          def logger
+            @parent.send(:logger)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/conversant/v3/services/cdn/dashboard.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+module Conversant
+  module V3
+    module Services
+      class CDN
+        # Dashboard service for CDN quick metrics
+        #
+        # Provides daily aggregated metrics for bandwidth and volume
+        # suitable for dashboard displays and quick overviews.
+        #
+        # @example Get dashboard metrics
+        #   cdn = Conversant::V3.cdn(12345)
+        #
+        #   bandwidth = cdn.dashboard.bandwidth({
+        #     customerId: "12345",
+        #     startTime: "2025-01-01T00:00:00Z",
+        #     endTime: "2025-01-31T00:00:00Z",
+        #     interval: "day",
+        #     fillFixedTime: true
+        #   })
+        #
+        #   volume = cdn.dashboard.volume({
+        #     customerId: "12345",
+        #     startTime: "2025-01-01T00:00:00Z",
+        #     endTime: "2025-01-31T00:00:00Z",
+        #     interval: "day"
+        #   })
+        #
+        # @since 1.0.8
+        class Dashboard
+          # @return [CDN] the parent CDN service instance
+          attr_reader :parent
+
+          # Initialize dashboard service
+          #
+          # @param parent [CDN] the parent CDN service instance
+          def initialize(parent)
+            @parent = parent
+          end
+
+          # Get daily bandwidth metrics
+          #
+          # @param payload [Hash] bandwidth query parameters
+          # @option payload [String] :customerId customer ID
+          # @option payload [String] :startTime start time in ISO 8601 format
+          # @option payload [String] :endTime end time in ISO 8601 format
+          # @option payload [String] :interval time interval (typically "day")
+          # @option payload [Boolean] :fillFixedTime fill missing time slots
+          # @option payload [String] :daHostName specific hostname filter
+          #
+          # @return [Hash] bandwidth data with time series, or nil on error
+          #
+          # @example Get daily bandwidth for dashboard
+          #   bandwidth = cdn.dashboard.bandwidth({
+          #     customerId: "34194",
+          #     startTime: "2025-01-01T00:00:00Z",
+          #     endTime: "2025-01-31T00:00:00Z",
+          #     interval: "day",
+          #     fillFixedTime: true,
+          #     daHostName: ""
+          #   })
+          #   puts "Total: #{bandwidth['total']} Mbps"
+          #
+          # @since 1.0.8
+          def bandwidth(payload)
+            response = @parent.send(:call, 'POST', '/api/report/bandwidth/day', payload)
+            JSON.parse(response)
+          rescue StandardError => e
+            @parent.send(:logger).error "#{@parent.send(:identifier)}.METHOD:dashboard.bandwidth.EXCEPTION:#{e.message}"
+            nil
+          end
+
+          # Get daily volume metrics
+          #
+          # @param payload [Hash] volume query parameters
+          # @option payload [String] :customerId customer ID
+          # @option payload [String] :startTime start time in ISO 8601 format
+          # @option payload [String] :endTime end time in ISO 8601 format
+          # @option payload [String] :interval time interval (typically "day")
+          # @option payload [Boolean] :fillFixedTime fill missing time slots
+          # @option payload [String] :daHostName specific hostname filter
+          #
+          # @return [Hash] volume data with time series, or nil on error
+          #
+          # @example Get daily volume for dashboard
+          #   volume = cdn.dashboard.volume({
+          #     customerId: "34194",
+          #     startTime: "2025-01-01T00:00:00Z",
+          #     endTime: "2025-01-31T00:00:00Z",
+          #     interval: "day",
+          #     fillFixedTime: true,
+          #     daHostName: ""
+          #   })
+          #   puts "Total: #{volume['total']} GB"
+          #
+          # @since 1.0.8
+          def volume(payload)
+            response = @parent.send(:call, 'POST', '/api/report/volume/day', payload)
+            JSON.parse(response)
+          rescue StandardError => e
+            @parent.send(:logger).error "#{@parent.send(:identifier)}.METHOD:dashboard.volume.EXCEPTION:#{e.message}"
+            nil
+          end
+        end
+      end
+    end
+  end
+end