conversant 1.0.16

data/lib/conversant/v3/services/lms/partner/analytics.rb

@@ -0,0 +1,266 @@
+# frozen_string_literal: true
+
+module Conversant
+  module V3
+    module Services
+      class LMS
+        class Partner
+          # LMS analytics service for partner-level reporting
+          #
+          # Provides partner-level analytics and reporting for Live Media Streaming services
+          # including live duration, recording duration, transcoding metrics, and job statistics
+          # across multiple customer accounts.
+          #
+          # @since 1.0.12
+          class Analytics
+            # @return [Conversant::V3::Services::LMS] the parent LMS service instance
+            attr_reader :parent
+
+            # Initialize partner LMS analytics service
+            #
+            # @param parent [Conversant::V3::Services::LMS] the parent LMS service instance
+            def initialize(parent)
+              @parent = parent
+            end
+
+            # Get report service instance
+            #
+            # Provides access to detailed partner-level reporting for LMS services
+            # including transcoding, recording, jobs, and DRM analytics.
+            #
+            # @return [Report] report service for LMS detailed analytics
+            # @since 1.0.15
+            #
+            # @example Access report methods
+            #   lms = Conversant::V3.lms(12345)
+            #   report = lms.partner.analytics.report
+            #   transcodings = report.transcodings(startTime: '2025-01-01', endTime: '2025-01-31')
+            def report
+              @report ||= Report.new(self)
+            end
+
+            # Get business service instance
+            #
+            # Provides access to business-focused analytics that aggregate transcoding,
+            # recording, and streaming data for billing and capacity planning.
+            #
+            # @return [Business] business service for LMS aggregated analytics
+            # @since 1.0.15
+            #
+            # @example Access business methods
+            #   lms = Conversant::V3.lms(12345)
+            #   business = lms.partner.analytics.business
+            #   metrics = business.transcoding(startTime: Time.now.beginning_of_month)
+            def business
+              @business ||= Business.new(self)
+            end
+
+            # Get duration of live streaming for business usage reporting
+            #
+            # @param args [Hash] query parameters
+            # @option args [Time, String] :startTime start time for the report (defaults to beginning of current month)
+            # @option args [String, Integer] :type customer type filter (defaults to 2)
+            #
+            # @return [Array] live streaming duration data, or empty array on error
+            # @since 1.0.8
+            def duration_of_live(**args)
+              month, type, timestamp = queries(**args)
+
+              payload = {
+                month: month,
+                selectType: 'ltd',
+                customerType: type,
+                _: timestamp
+              }
+
+              response = @parent.send(:call, 'GET', "/v4/reporting/lms/business/usage/search?#{payload.to_query}")
+              return [] if response.nil?
+
+              JSON.parse(response)&.map(&:with_indifferent_access) || []
+            rescue StandardError => e
+              @parent.send(:logger).error "#{@parent.send(:identifier)}.METHOD:#{__method__}.EXCEPTION:#{e.message}"
+              []
+            end
+
+            # Get duration of live recording for business usage reporting
+            #
+            # @param args [Hash] query parameters
+            # @option args [Time, String] :startTime start time for the report (defaults to beginning of current month)
+            # @option args [String, Integer] :type customer type filter (defaults to 2)
+            #
+            # @return [Array] recording duration data, or empty array on error
+            # @since 1.0.8
+            def duration_of_live_recording(**args)
+              month, type, timestamp = queries(**args)
+
+              payload = {
+                month: month,
+                selectType: 'rtd',
+                customerType: type,
+                _: timestamp
+              }
+
+              response = @parent.send(:call, 'GET', "/v4/reporting/lms/business/usage/search?#{payload.to_query}")
+              return [] if response.nil?
+
+              JSON.parse(response)&.map(&:with_indifferent_access) || []
+            rescue StandardError => e
+              @parent.send(:logger).error "#{@parent.send(:identifier)}.METHOD:#{__method__}.EXCEPTION:#{e.message}"
+              []
+            end
+
+            # Get number of live streaming jobs for business usage reporting
+            #
+            # @param args [Hash] query parameters
+            # @option args [Time, String] :startTime start time for the report (defaults to beginning of current month)
+            # @option args [String, Integer] :type customer type filter (defaults to 2)
+            #
+            # @return [Array] live job count data, or empty array on error
+            # @since 1.0.8
+            def no_of_live_jobs(**args)
+              month, type, timestamp = queries(**args)
+
+              payload = {
+                month: month,
+                selectType: 'ltn',
+                customerType: type,
+                _: timestamp
+              }
+
+              response = @parent.send(:call, 'GET', "/v4/reporting/lms/business/usage/search?#{payload.to_query}")
+              return [] if response.nil?
+
+              JSON.parse(response)&.map(&:with_indifferent_access) || []
+            rescue StandardError => e
+              @parent.send(:logger).error "#{@parent.send(:identifier)}.METHOD:#{__method__}.EXCEPTION:#{e.message}"
+              []
+            end
+
+            # Get duration metrics by scope (live/recording/transcoding)
+            #
+            # @param scope [String] scope type (e.g., 'live', 'recording', 'transcoding')
+            # @param params [Hash] query parameters
+            #
+            # @return [Array] duration data for specified scope, or empty array on error
+            # @since 1.0.8
+            def durations(scope, params = {})
+              query_string = params.map { |k, v| "#{k}=#{v}" }.join('&')
+              uri = "/v2/reporting/lms/#{scope}/duration"
+              uri += "?#{query_string}" unless query_string.empty?
+              response = @parent.send(:call, 'GET', uri)
+              return [] if response.nil?
+
+              JSON.parse(response)&.map(&:with_indifferent_access) || []
+            rescue StandardError => e
+              @parent.send(:logger).error "#{@parent.send(:identifier)}.METHOD:#{__method__}.EXCEPTION:#{e.message}"
+              []
+            end
+
+            # Get transcoding duration metrics
+            #
+            # @param params [Hash] query parameters
+            # @option params [String] :startTime start time
+            # @option params [String] :endTime end time
+            #
+            # @return [Hash] transcoding duration data, or nil on error
+            # @since 1.0.8
+            def transcodings(params = {})
+              query_string = params.map { |k, v| "#{k}=#{v}" }.join('&')
+              uri = '/reporting/lms/transcoding/duration'
+              uri += "?#{query_string}" unless query_string.empty?
+              response = @parent.send(:call, 'GET', uri)
+              JSON.parse(response)
+            rescue StandardError => e
+              @parent.send(:logger).error "#{@parent.send(:identifier)}.METHOD:#{__method__}.EXCEPTION:#{e.message}"
+              nil
+            end
+
+            # Get recording duration metrics
+            #
+            # @param params [Hash] query parameters
+            # @option params [String] :startTime start time
+            # @option params [String] :endTime end time
+            #
+            # @return [Hash] recording duration data, or nil on error
+            # @since 1.0.8
+            def recordings(params = {})
+              query_string = params.map { |k, v| "#{k}=#{v}" }.join('&')
+              uri = '/reporting/lms/recording/duration'
+              uri += "?#{query_string}" unless query_string.empty?
+              response = @parent.send(:call, 'GET', uri)
+              JSON.parse(response)
+            rescue StandardError => e
+              @parent.send(:logger).error "#{@parent.send(:identifier)}.METHOD:#{__method__}.EXCEPTION:#{e.message}"
+              nil
+            end
+
+            # Get transcoding job count metrics
+            #
+            # @param params [Hash] query parameters
+            # @option params [String] :startTime start time
+            # @option params [String] :endTime end time
+            #
+            # @return [Hash] job count data, or nil on error
+            # @since 1.0.8
+            def jobs(params = {})
+              query_string = params.map { |k, v| "#{k}=#{v}" }.join('&')
+              uri = '/reporting/lms/transcoding/number'
+              uri += "?#{query_string}" unless query_string.empty?
+              response = @parent.send(:call, 'GET', uri)
+              JSON.parse(response)
+            rescue StandardError => e
+              @parent.send(:logger).error "#{@parent.send(:identifier)}.METHOD:#{__method__}.EXCEPTION:#{e.message}"
+              nil
+            end
+
+            # Get transcoding duration metrics (v2 endpoint)
+            #
+            # @param params [Hash] query parameters
+            # @option params [String] :startTime start time
+            # @option params [String] :endTime end time
+            #
+            # @return [Hash, nil] transcoding duration data, or nil on error
+            # @since 1.0.8
+            def duration_v2_transcoding(params = {})
+              query_string = params.map { |k, v| "#{k}=#{v}" }.join('&')
+              uri = '/v2/reporting/lms/transcoding/duration'
+              uri += "?#{query_string}" unless query_string.empty?
+              response = @parent.send(:call, 'GET', uri)
+              return nil if response.nil?
+
+              JSON.parse(response)
+            rescue StandardError => e
+              @parent.send(:logger).error "#{@parent.send(:identifier)}.METHOD:#{__method__}.EXCEPTION:#{e.message}"
+              nil
+            end
+
+            private
+
+            def logger
+              @parent.send(:logger)
+            end
+
+            # Helper method to build query parameters
+            #
+            # Generates month, customer type, and timestamp parameters for LMS business usage queries.
+            # Defaults to current month if startTime is not provided.
+            #
+            # @param args [Hash] Input parameters
+            # @option args [Time, String] :startTime Start time for the report (defaults to beginning of current month)
+            # @option args [String, Integer] :type Customer type filter (defaults to parent's type or 2)
+            #
+            # @return [Array<String, Integer, Integer>] Array containing [month (YYYYMM), customer_type, timestamp (ms)]
+            def queries(**args)
+              month = (args[:startTime] || Time.now&.beginning_of_month)&.to_datetime&.strftime('%Y%m')
+              customer_type = args[:type]
+              customer_type = @parent.type || 2 unless customer_type.present?
+              timestamp = Time.now.getutc.to_i * 1000
+
+              [month, customer_type, timestamp]
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/conversant/v3/services/lms/partner/business.rb

@@ -0,0 +1,151 @@
+# frozen_string_literal: true
+
+module Conversant
+  module V3
+    module Services
+      class LMS
+        class Partner
+          # LMS Business analytics for partner-level business reporting
+          #
+          # Provides business-focused analytics methods that aggregate transcoding,
+          # recording, and streaming data for billing and capacity planning.
+          #
+          # @since 1.0.15
+          class Business
+            # @return [Conversant::V3::Services::LMS::Partner::Analytics] the parent analytics instance
+            attr_reader :parent
+
+            # Initialize partner LMS business service
+            #
+            # @param parent [Conversant::V3::Services::LMS::Partner::Analytics] the parent analytics instance
+            def initialize(parent)
+              @parent = parent
+            end
+
+            # Fetches transcoding business analytics with codec breakdown
+            #
+            # Aggregates transcoding data including transmuxing, audio-only, and transcoding
+            # across different resolutions (SD, HD, UHD) and codecs (H264, H265).
+            #
+            # @param args [Hash] Parameters for the query
+            # @option args [Time, String] :startTime start time for the report (defaults to beginning of current month)
+            # @option args [String, Integer] :type customer type filter (defaults to 2)
+            #
+            # @return [Hash, nil] Transcoding business data with breakdown by codec and resolution, or nil if no data
+            #
+            # @example Get transcoding business metrics
+            #   business = lms.partner.analytics.business
+            #   metrics = business.transcoding(startTime: Time.now.beginning_of_month)
+            #   puts "Total transcoding: #{metrics[:lms_transcoding]} minutes"
+            #   puts "SD: #{metrics[:lms_transcoding_sd]}, HD: #{metrics[:lms_transcoding_hd]}, UHD: #{metrics[:lms_transcoding_uhd]}"
+            #
+            # @since 1.0.15
+            def transcoding(**args)
+              transcode = {
+                lms_transcoding: 0,
+                lms_transmuxing: 0,
+                lms_transcoding_sd: 0,
+                lms_transcoding_hd: 0,
+                lms_transcoding_uhd: 0,
+                lms_audio_only: 0
+              }
+
+              data = @parent.duration_of_live(**args).first
+              return nil if data.nil?
+
+              name = data.keys.first
+
+              data[name]&.each do |item|
+                transcode[:lms_transmuxing] += item[:transmux].to_f
+                transcode[:lms_audio_only] += item[:audioOnly].to_f
+                transcode[:lms_transcoding_sd] += item[:h264SdTranscoding].to_f + item[:h265SdTranscoding].to_f
+                transcode[:lms_transcoding_hd] += item[:h264HdTranscoding].to_f + item[:h265HdTranscoding].to_f
+                transcode[:lms_transcoding_uhd] += item[:h264UhdTranscoding].to_f + item[:h265UhdTranscoding].to_f
+              end
+
+              transcode[:lms_transcoding] =
+                transcode[:lms_transcoding_sd] + transcode[:lms_transcoding_hd] + transcode[:lms_transcoding_uhd]
+              transcode
+            rescue StandardError => e
+              logger.error "#{@parent.send(:identifier)}.METHOD:#{__method__}.EXCEPTION:#{e.message}"
+              nil
+            end
+
+            # Fetches recording business analytics with codec breakdown
+            #
+            # Aggregates recording data including total recording duration, transmuxing,
+            # audio-only, and transcoding across different resolutions and codecs.
+            #
+            # @param args [Hash] Parameters for the query
+            # @option args [Time, String] :startTime start time for the report (defaults to beginning of current month)
+            # @option args [String, Integer] :type customer type filter (defaults to 2)
+            #
+            # @return [Hash, nil] Recording business data with breakdown by codec and resolution, or nil if no data
+            #
+            # @example Get recording business metrics
+            #   business = lms.partner.analytics.business
+            #   metrics = business.recording(startTime: Time.now.beginning_of_month)
+            #   puts "Total recording: #{metrics[:lms_recording]} minutes"
+            #
+            # @since 1.0.15
+            def recording(**args)
+              recording = {
+                lms_recording: 0,
+                lms_transmuxing: 0,
+                lms_transcoding_sd: 0,
+                lms_transcoding_hd: 0,
+                lms_transcoding_uhd: 0,
+                lms_audio_only: 0
+              }
+
+              data = @parent.duration_of_live_recording(**args).first
+              return nil if data.nil?
+
+              name = data.keys.first
+
+              data[name]&.each do |item|
+                recording[:lms_recording] += item[:total].to_f
+                recording[:lms_transmuxing] += item[:transmux].to_f
+                recording[:lms_audio_only] += item[:audioOnly].to_f
+                recording[:lms_transcoding_sd] += item[:h264SdTranscoding].to_f + item[:h265SdTranscoding].to_f
+                recording[:lms_transcoding_hd] += item[:h264HdTranscoding].to_f + item[:h265HdTranscoding].to_f
+                recording[:lms_transcoding_uhd] += item[:h264UhdTranscoding].to_f + item[:h265UhdTranscoding].to_f
+              end
+
+              recording
+            rescue StandardError => e
+              logger.error "#{@parent.send(:identifier)}.METHOD:#{__method__}.EXCEPTION:#{e.message}"
+              nil
+            end
+
+            # Fetches stream jobs data
+            #
+            # Retrieves the number of live streaming jobs for business usage reporting.
+            # This is an alias for the parent analytics' no_of_live_jobs method.
+            #
+            # @param args [Hash] Parameters for the query
+            # @option args [Time, String] :startTime start time for the report (defaults to beginning of current month)
+            # @option args [String, Integer] :type customer type filter (defaults to 2)
+            #
+            # @return [Array] Stream jobs count data, or empty array on error
+            #
+            # @example Get stream jobs count
+            #   business = lms.partner.analytics.business
+            #   jobs = business.stream_jobs(startTime: Time.now.beginning_of_month)
+            #
+            # @since 1.0.15
+            def stream_jobs(**args)
+              @parent.no_of_live_jobs(**args)
+            end
+
+            private
+
+            def logger
+              @parent.send(:logger)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/conversant/v3/services/lms/partner/report.rb

@@ -0,0 +1,170 @@
+# frozen_string_literal: true
+
+module Conversant
+  module V3
+    module Services
+      class LMS
+        class Partner
+          # LMS Report analytics for detailed partner-level reporting
+          #
+          # Provides detailed reporting methods for transcoding, recording, jobs,
+          # DRM analytics, and business usage data.
+          #
+          # @since 1.0.15
+          class Report
+            # @return [Conversant::V3::Services::LMS::Partner::Analytics] the parent analytics instance
+            attr_reader :parent
+
+            # Initialize partner LMS report service
+            #
+            # @param parent [Conversant::V3::Services::LMS::Partner::Analytics] the parent analytics instance
+            def initialize(parent)
+              @parent = parent
+            end
+
+            # Fetches transcoding analytics data
+            #
+            # Retrieves detailed transcoding duration metrics for live streaming services,
+            # useful for billing calculations and capacity planning.
+            #
+            # @param payload [Hash] Parameters for the query
+            # @option payload [String] :startTime start time in ISO 8601 format or timestamp
+            # @option payload [String] :endTime end time in ISO 8601 format or timestamp
+            #
+            # @return [Hash, nil] Transcoding duration data with breakdown by resolution and codec, or nil on error
+            #
+            # @example Get transcoding data for a time range
+            #   report = lms.partner.analytics.report
+            #   data = report.transcodings(startTime: '2025-01-01', endTime: '2025-01-31')
+            #
+            # @since 1.0.15
+            def transcodings(payload)
+              response = @parent.instance_variable_get(:@parent).send(:call, 'GET', "/reporting/lms/transcoding/duration?#{payload.to_query}")
+              return nil if response.nil?
+
+              JSON.parse(response)
+            rescue StandardError => e
+              logger.error "#{identifier}.METHOD:#{__method__}.EXCEPTION:#{e.message}"
+              nil
+            end
+
+            # Fetches recording analytics data
+            #
+            # Retrieves detailed recording duration metrics for live streaming recordings,
+            # including breakdown by codec and resolution for billing purposes.
+            #
+            # @param payload [Hash] Parameters for the query
+            # @option payload [String] :startTime start time in ISO 8601 format or timestamp
+            # @option payload [String] :endTime end time in ISO 8601 format or timestamp
+            #
+            # @return [Hash, nil] Recording duration data with codec breakdown, or nil on error
+            #
+            # @example Get recording data for a time range
+            #   report = lms.partner.analytics.report
+            #   data = report.recordings(startTime: '2025-01-01', endTime: '2025-01-31')
+            #
+            # @since 1.0.15
+            def recordings(payload)
+              response = @parent.instance_variable_get(:@parent).send(:call, 'GET', "/reporting/lms/recording/duration?#{payload.to_query}")
+              return nil if response.nil?
+
+              JSON.parse(response)
+            rescue StandardError => e
+              logger.error "#{identifier}.METHOD:#{__method__}.EXCEPTION:#{e.message}"
+              nil
+            end
+
+            # Fetches transcoding jobs count analytics
+            #
+            # Retrieves the number of transcoding jobs executed within a specified time range,
+            # useful for understanding service usage patterns and billing.
+            #
+            # @param payload [Hash] Parameters for the query
+            # @option payload [String] :startTime start time in ISO 8601 format or timestamp
+            # @option payload [String] :endTime end time in ISO 8601 format or timestamp
+            #
+            # @return [Hash, nil] Jobs count data by time period, or nil on error
+            #
+            # @example Get job counts for a time range
+            #   report = lms.partner.analytics.report
+            #   data = report.jobs(startTime: '2025-01-01', endTime: '2025-01-31')
+            #
+            # @since 1.0.15
+            def jobs(payload)
+              response = @parent.instance_variable_get(:@parent).send(:call, 'GET', "/reporting/lms/transcoding/number?#{payload.to_query}")
+              return nil if response.nil?
+
+              JSON.parse(response)
+            rescue StandardError => e
+              logger.error "#{identifier}.METHOD:#{__method__}.EXCEPTION:#{e.message}"
+              nil
+            end
+
+            # Fetches v2 transcoding duration data
+            #
+            # Retrieves transcoding duration metrics using the v2 API endpoint.
+            # This provides backward compatibility with the legacy reporting format.
+            #
+            # @param payload [Hash] Parameters for the query
+            # @option payload [String] :startTime start time in ISO 8601 format or timestamp
+            # @option payload [String] :endTime end time in ISO 8601 format or timestamp
+            #
+            # @return [Hash, nil] Transcoding duration data in v2 format, or nil on error
+            #
+            # @example Get v2 transcoding duration
+            #   report = lms.partner.analytics.report
+            #   data = report.duration_v2_transcoding(startTime: '2025-01-01', endTime: '2025-01-31')
+            #
+            # @since 1.0.15
+            def duration_v2_transcoding(payload)
+              response = @parent.instance_variable_get(:@parent).send(:call, 'GET', "/v2/reporting/lms/transcoding/duration?#{payload.to_query}")
+              return nil if response.nil?
+
+              JSON.parse(response)
+            rescue StandardError => e
+              logger.error "#{identifier}.METHOD:#{__method__}.EXCEPTION:#{e.message}"
+              nil
+            end
+
+            # Fetches business live usage data
+            #
+            # Retrieves business-level live streaming usage data aggregated by month,
+            # including filtering by customer type and metric selection type.
+            #
+            # @param payload [Hash] Parameters for the query
+            # @option payload [String] :month month in YYYYMM format (e.g., '202501' for January 2025)
+            # @option payload [String] :selectType select type filter ('ltd' for live duration, 'rtd' for recording, 'ltn' for job count)
+            # @option payload [String] :customerType customer type filter (e.g., '2' for standard customers)
+            #
+            # @return [Hash, nil] Business live usage data with detailed metrics, or nil on error
+            #
+            # @example Get live duration for January 2025
+            #   report = lms.partner.analytics.report
+            #   data = report.bussiness_live_usage(month: '202501', selectType: 'ltd', customerType: '2')
+            #
+            # @since 1.0.15
+            def bussiness_live_usage(payload)
+              response = @parent.instance_variable_get(:@parent).send(:call, 'GET', "/v4/reporting/lms/business/usage/search?#{payload.to_query}")
+              return nil if response.nil?
+
+              JSON.parse(response)
+            rescue StandardError => e
+              logger.error "#{identifier}.METHOD:#{__method__}.EXCEPTION:#{e.message}"
+              nil
+            end
+
+            private
+
+            def logger
+              @parent.instance_variable_get(:@parent).send(:logger)
+            end
+
+            def identifier
+              @parent.instance_variable_get(:@parent).send(:identifier)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/conversant/v3/services/lms/partner.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Conversant
+  module V3
+    module Services
+      class LMS
+        # Partner service for LMS partner-level operations
+        #
+        # Provides access to partner-level analytics for Live Media Streaming
+        # that aggregate data across multiple customer accounts.
+        #
+        # @example Access partner analytics
+        #   lms = Conversant::V3.lms(12345)
+        #
+        #   # Partner-level LMS analytics
+        #   duration = lms.partner.analytics.duration({
+        #     startTime: "2025-01-01T00:00:00Z",
+        #     endTime: "2025-01-31T23:59:59Z"
+        #   })
+        #
+        # @since 1.0.12
+        class Partner
+          # @return [LMS] the parent LMS service instance
+          attr_reader :parent
+
+          # Initialize partner service
+          #
+          # @param parent [LMS] the parent LMS service instance
+          def initialize(parent)
+            @parent = parent
+          end
+
+          # Get partner analytics service instance
+          #
+          # Provides partner-level analytics for LMS services including streaming
+          # duration, bandwidth, and viewer metrics across multiple customers.
+          #
+          # @return [Analytics] LMS partner analytics service
+          # @since 1.0.12
+          def analytics
+            @analytics ||= Analytics.new(@parent)
+          end
+
+          private
+
+          def logger
+            @parent.send(:logger)
+          end
+        end
+      end
+    end
+  end
+end
+
+# Load nested analytics class after Partner is defined
+require_relative 'partner/analytics'
+require_relative 'partner/report'
+require_relative 'partner/business'