wavix-ruby-sdk 1.0.0

data/lib/wavix/cdrs/client.rb

@@ -0,0 +1,277 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Cdrs
+    class Client
+      # @param client [Wavix::Internal::Http::RawClient]
+      #
+      # @return [void]
+      def initialize(client:)
+        @client = client
+      end
+
+      # Returns a paginated list of call detail records for the authenticated account, within the requested date range.
+      #
+      # @param request_options [Hash]
+      # @param params [Hash]
+      # @option request_options [String] :base_url
+      # @option request_options [Hash{String => Object}] :additional_headers
+      # @option request_options [Hash{String => Object}] :additional_query_parameters
+      # @option request_options [Hash{String => Object}] :additional_body_parameters
+      # @option request_options [Integer] :timeout_in_seconds
+      # @option params [String] :from
+      # @option params [String] :to
+      # @option params [String] :type
+      # @option params [Wavix::Types::CallDisposition, nil] :disposition
+      # @option params [String, nil] :from_search
+      # @option params [String, nil] :to_search
+      # @option params [String, nil] :sip_trunk
+      # @option params [String, nil] :uuid
+      # @option params [Integer, nil] :page
+      # @option params [Integer, nil] :per_page
+      #
+      # @return [Wavix::Types::CdrListResponse]
+      def list(request_options: {}, **params)
+        params = Wavix::Internal::Types::Utils.normalize_keys(params)
+        query_params = {}
+        query_params["from"] = params[:from] if params.key?(:from)
+        query_params["to"] = params[:to] if params.key?(:to)
+        query_params["type"] = params[:type] if params.key?(:type)
+        query_params["disposition"] = params[:disposition] if params.key?(:disposition)
+        query_params["from_search"] = params[:from_search] if params.key?(:from_search)
+        query_params["to_search"] = params[:to_search] if params.key?(:to_search)
+        query_params["sip_trunk"] = params[:sip_trunk] if params.key?(:sip_trunk)
+        query_params["uuid"] = params[:uuid] if params.key?(:uuid)
+        query_params["page"] = params[:page] if params.key?(:page)
+        query_params["per_page"] = params[:per_page] if params.key?(:per_page)
+
+        request = Wavix::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "GET",
+          path: "v1/cdrs",
+          query: query_params,
+          request_options: request_options
+        )
+        begin
+          response = @client.send(request)
+        rescue Net::HTTPRequestTimeout
+          raise Wavix::Errors::TimeoutError
+        end
+        code = response.code.to_i
+        if code.between?(200, 299)
+          Wavix::Types::CdrListResponse.load(response.body)
+        else
+          error_class = Wavix::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # Searches call transcriptions for the given keywords or phrases and returns the matching CDRs with their
+      # transcriptions.
+      #
+      # @param request_options [Hash]
+      # @param params [Wavix::Cdrs::Types::CdrSearchRequest]
+      # @option request_options [String] :base_url
+      # @option request_options [Hash{String => Object}] :additional_headers
+      # @option request_options [Hash{String => Object}] :additional_query_parameters
+      # @option request_options [Hash{String => Object}] :additional_body_parameters
+      # @option request_options [Integer] :timeout_in_seconds
+      #
+      # @return [Wavix::Types::CdrTranscriptionSearchResponse]
+      def search(request_options: {}, **params)
+        params = Wavix::Internal::Types::Utils.normalize_keys(params)
+        request = Wavix::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "POST",
+          path: "v1/cdrs",
+          body: Wavix::Cdrs::Types::CdrSearchRequest.new(params).to_h,
+          request_options: request_options
+        )
+        begin
+          response = @client.send(request)
+        rescue Net::HTTPRequestTimeout
+          raise Wavix::Errors::TimeoutError
+        end
+        code = response.code.to_i
+        if code.between?(200, 299)
+          Wavix::Types::CdrTranscriptionSearchResponse.load(response.body)
+        else
+          error_class = Wavix::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # Transcribes the recording of the call identified by `call_id`. Transcription is asynchronous; poll the
+      # transcription endpoint for the result.
+      #
+      # @param request_options [Hash]
+      # @param params [Wavix::Cdrs::Types::CdrRetranscriptionRequest]
+      # @option request_options [String] :base_url
+      # @option request_options [Hash{String => Object}] :additional_headers
+      # @option request_options [Hash{String => Object}] :additional_query_parameters
+      # @option request_options [Hash{String => Object}] :additional_body_parameters
+      # @option request_options [Integer] :timeout_in_seconds
+      # @option params [String] :call_id
+      #
+      # @return [Wavix::Types::SuccessResponse]
+      def retranscribe(request_options: {}, **params)
+        params = Wavix::Internal::Types::Utils.normalize_keys(params)
+        request_data = Wavix::Cdrs::Types::CdrRetranscriptionRequest.new(params).to_h
+        non_body_param_names = %w[call_id]
+        body = request_data.except(*non_body_param_names)
+
+        request = Wavix::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "PUT",
+          path: "v1/cdrs/#{URI.encode_uri_component(params[:call_id].to_s)}/retranscribe",
+          body: body,
+          request_options: request_options
+        )
+        begin
+          response = @client.send(request)
+        rescue Net::HTTPRequestTimeout
+          raise Wavix::Errors::TimeoutError
+        end
+        code = response.code.to_i
+        if code.between?(200, 299)
+          Wavix::Types::SuccessResponse.load(response.body)
+        else
+          error_class = Wavix::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # Returns the transcription of the recorded call identified by `call_id`. Alias of the `transcription` endpoint.
+      #
+      # @param request_options [Hash]
+      # @param params [Hash]
+      # @option request_options [String] :base_url
+      # @option request_options [Hash{String => Object}] :additional_headers
+      # @option request_options [Hash{String => Object}] :additional_query_parameters
+      # @option request_options [Hash{String => Object}] :additional_body_parameters
+      # @option request_options [Integer] :timeout_in_seconds
+      # @option params [String] :call_id
+      #
+      # @return [Wavix::Types::CdrTranscriptionResponse]
+      def transcriptions(request_options: {}, **params)
+        params = Wavix::Internal::Types::Utils.normalize_keys(params)
+        request = Wavix::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "GET",
+          path: "v1/cdrs/#{URI.encode_uri_component(params[:call_id].to_s)}/transcriptions",
+          request_options: request_options
+        )
+        begin
+          response = @client.send(request)
+        rescue Net::HTTPRequestTimeout
+          raise Wavix::Errors::TimeoutError
+        end
+        code = response.code.to_i
+        if code.between?(200, 299)
+          Wavix::Types::CdrTranscriptionResponse.load(response.body)
+        else
+          error_class = Wavix::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # Returns the call detail record for the call identified by `call_id`.
+      #
+      # @param request_options [Hash]
+      # @param params [Hash]
+      # @option request_options [String] :base_url
+      # @option request_options [Hash{String => Object}] :additional_headers
+      # @option request_options [Hash{String => Object}] :additional_query_parameters
+      # @option request_options [Hash{String => Object}] :additional_body_parameters
+      # @option request_options [Integer] :timeout_in_seconds
+      # @option params [String] :call_id
+      # @option params [Boolean, nil] :show_transcription
+      #
+      # @return [Wavix::Types::CdrResponse]
+      def get(request_options: {}, **params)
+        params = Wavix::Internal::Types::Utils.normalize_keys(params)
+        query_params = {}
+        query_params["show_transcription"] = params[:show_transcription] if params.key?(:show_transcription)
+
+        request = Wavix::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "GET",
+          path: "v1/cdrs/#{URI.encode_uri_component(params[:call_id].to_s)}",
+          query: query_params,
+          request_options: request_options
+        )
+        begin
+          response = @client.send(request)
+        rescue Net::HTTPRequestTimeout
+          raise Wavix::Errors::TimeoutError
+        end
+        code = response.code.to_i
+        if code.between?(200, 299)
+          Wavix::Types::CdrResponse.load(response.body)
+        else
+          error_class = Wavix::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # Streams matching call detail records as newline-delimited JSON (NDJSON), one record per line, for bulk export.
+      #
+      # @param request_options [Hash]
+      # @param params [Hash]
+      # @option request_options [String] :base_url
+      # @option request_options [Hash{String => Object}] :additional_headers
+      # @option request_options [Hash{String => Object}] :additional_query_parameters
+      # @option request_options [Hash{String => Object}] :additional_body_parameters
+      # @option request_options [Integer] :timeout_in_seconds
+      # @option params [String] :from
+      # @option params [String] :to
+      # @option params [String] :type
+      # @option params [Wavix::Types::CallDisposition, nil] :disposition
+      # @option params [String, nil] :from_search
+      # @option params [String, nil] :to_search
+      # @option params [String, nil] :sip_trunk
+      # @option params [String, nil] :uuid
+      # @option params [Integer, nil] :page
+      # @option params [Integer, nil] :per_page
+      #
+      # @return [String]
+      def list_all(request_options: {}, **params)
+        params = Wavix::Internal::Types::Utils.normalize_keys(params)
+        query_params = {}
+        query_params["from"] = params[:from] if params.key?(:from)
+        query_params["to"] = params[:to] if params.key?(:to)
+        query_params["type"] = params[:type] if params.key?(:type)
+        query_params["disposition"] = params[:disposition] if params.key?(:disposition)
+        query_params["from_search"] = params[:from_search] if params.key?(:from_search)
+        query_params["to_search"] = params[:to_search] if params.key?(:to_search)
+        query_params["sip_trunk"] = params[:sip_trunk] if params.key?(:sip_trunk)
+        query_params["uuid"] = params[:uuid] if params.key?(:uuid)
+        query_params["page"] = params[:page] if params.key?(:page)
+        query_params["per_page"] = params[:per_page] if params.key?(:per_page)
+
+        request = Wavix::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "GET",
+          path: "v1/cdrs/all",
+          query: query_params,
+          request_options: request_options
+        )
+        begin
+          response = @client.send(request)
+        rescue Net::HTTPRequestTimeout
+          raise Wavix::Errors::TimeoutError
+        end
+        code = response.code.to_i
+        return if code.between?(200, 299)
+
+        error_class = Wavix::Errors::ResponseError.subclass_for_code(code)
+        raise error_class.new(response.body, code: code)
+      end
+
+      # @return [Wavix::Transcription::Client]
+      def transcription
+        @transcription ||= Wavix::Cdrs::Transcription::Client.new(client: @client)
+      end
+    end
+  end
+end

data/lib/wavix/cdrs/transcription/client.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Cdrs
+    module Transcription
+      class Client
+        # @param client [Wavix::Internal::Http::RawClient]
+        #
+        # @return [void]
+        def initialize(client:)
+          @client = client
+        end
+
+        # Returns the transcription of the recorded call identified by `call_id`, including the transcript, speaker
+        # turns, and summary.
+        #
+        # @param request_options [Hash]
+        # @param params [Hash]
+        # @option request_options [String] :base_url
+        # @option request_options [Hash{String => Object}] :additional_headers
+        # @option request_options [Hash{String => Object}] :additional_query_parameters
+        # @option request_options [Hash{String => Object}] :additional_body_parameters
+        # @option request_options [Integer] :timeout_in_seconds
+        # @option params [String] :call_id
+        #
+        # @return [Wavix::Types::CdrTranscriptionResponse]
+        def get(request_options: {}, **params)
+          params = Wavix::Internal::Types::Utils.normalize_keys(params)
+          request = Wavix::Internal::JSON::Request.new(
+            base_url: request_options[:base_url],
+            method: "GET",
+            path: "v1/cdrs/#{URI.encode_uri_component(params[:call_id].to_s)}/transcription",
+            request_options: request_options
+          )
+          begin
+            response = @client.send(request)
+          rescue Net::HTTPRequestTimeout
+            raise Wavix::Errors::TimeoutError
+          end
+          code = response.code.to_i
+          if code.between?(200, 299)
+            Wavix::Types::CdrTranscriptionResponse.load(response.body)
+          else
+            error_class = Wavix::Errors::ResponseError.subclass_for_code(code)
+            raise error_class.new(response.body, code: code)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/wavix/cdrs/transcription/types/get_transcription_request.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Cdrs
+    module Transcription
+      module Types
+        class GetTranscriptionRequest < Internal::Types::Model
+          field :call_id, -> { String }, optional: false, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/wavix/cdrs/types/cdr_retranscription_request.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Cdrs
+    module Types
+      class CdrRetranscriptionRequest < Internal::Types::Model
+        field :call_id, -> { String }, optional: false, nullable: false
+
+        field :language, -> { Wavix::Types::TranscriptionLanguage }, optional: true, nullable: false
+
+        field :webhook_url, -> { String }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/wavix/cdrs/types/cdr_search_request.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Cdrs
+    module Types
+      class CdrSearchRequest < Internal::Types::Model
+        field :type, -> { Wavix::Cdrs::Types::CdrSearchRequestType }, optional: false, nullable: false
+
+        field :from, -> { String }, optional: false, nullable: false
+
+        field :to, -> { String }, optional: false, nullable: false
+
+        field :from_search, -> { String }, optional: true, nullable: false
+
+        field :to_search, -> { String }, optional: true, nullable: false
+
+        field :sip_trunk, -> { String }, optional: true, nullable: false
+
+        field :min_duration, -> { Integer }, optional: true, nullable: false
+
+        field :transcription, -> { Wavix::Types::TranscriptionFilter }, optional: true, nullable: false
+
+        field :uuid, -> { String }, optional: true, nullable: false
+
+        field :disposition, -> { Wavix::Cdrs::Types::CdrSearchRequestDisposition }, optional: true, nullable: false
+
+        field :page, -> { Integer }, optional: false, nullable: false
+
+        field :per_page, -> { Integer }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/wavix/cdrs/types/cdr_search_request_disposition.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Cdrs
+    module Types
+      module CdrSearchRequestDisposition
+        extend Wavix::Internal::Types::Enum
+
+        ANSWERED = "answered"
+        NOANSWER = "noanswer"
+        BUSY = "busy"
+        FAILED = "failed"
+        ALL = "all"
+      end
+    end
+  end
+end

data/lib/wavix/cdrs/types/cdr_search_request_type.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Cdrs
+    module Types
+      module CdrSearchRequestType
+        extend Wavix::Internal::Types::Enum
+
+        PLACED = "placed"
+        RECEIVED = "received"
+      end
+    end
+  end
+end

data/lib/wavix/cdrs/types/get_cdrs_request.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Cdrs
+    module Types
+      class GetCdrsRequest < Internal::Types::Model
+        field :call_id, -> { String }, optional: false, nullable: false
+
+        field :show_transcription, -> { Internal::Types::Boolean }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/wavix/cdrs/types/list_all_cdrs_request.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Cdrs
+    module Types
+      class ListAllCdrsRequest < Internal::Types::Model
+        field :from, -> { String }, optional: false, nullable: false
+
+        field :to, -> { String }, optional: false, nullable: false
+
+        field :type, -> { String }, optional: false, nullable: false
+
+        field :disposition, -> { Wavix::Types::CallDisposition }, optional: true, nullable: false
+
+        field :from_search, -> { String }, optional: true, nullable: false
+
+        field :to_search, -> { String }, optional: true, nullable: false
+
+        field :sip_trunk, -> { String }, optional: true, nullable: false
+
+        field :uuid, -> { String }, optional: true, nullable: false
+
+        field :page, -> { Integer }, optional: true, nullable: false
+
+        field :per_page, -> { Integer }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/wavix/cdrs/types/list_cdrs_request.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Cdrs
+    module Types
+      class ListCdrsRequest < Internal::Types::Model
+        field :from, -> { String }, optional: false, nullable: false
+
+        field :to, -> { String }, optional: false, nullable: false
+
+        field :type, -> { String }, optional: false, nullable: false
+
+        field :disposition, -> { Wavix::Types::CallDisposition }, optional: true, nullable: false
+
+        field :from_search, -> { String }, optional: true, nullable: false
+
+        field :to_search, -> { String }, optional: true, nullable: false
+
+        field :sip_trunk, -> { String }, optional: true, nullable: false
+
+        field :uuid, -> { String }, optional: true, nullable: false
+
+        field :page, -> { Integer }, optional: true, nullable: false
+
+        field :per_page, -> { Integer }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/wavix/cdrs/types/transcriptions_cdrs_request.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Cdrs
+    module Types
+      class TranscriptionsCdrsRequest < Internal::Types::Model
+        field :call_id, -> { String }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/wavix/client.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+module Wavix
+  class Client
+    # @param token [String]
+    # @param base_url [String, nil]
+    # @param max_retries [Integer]
+    #
+    # @return [void]
+    def initialize(token:, base_url: nil, max_retries: 2)
+      @raw_client = Wavix::Internal::Http::RawClient.new(
+        base_url: base_url || Wavix::Environment::DEFAULT,
+        headers: {
+          "User-Agent" => "wavix-ruby-sdk/1.0.0",
+          "X-Fern-Language" => "Ruby",
+          Authorization: "Bearer #{token}"
+        },
+        max_retries: max_retries
+      )
+    end
+
+    # @return [Wavix::APIKeys::Client]
+    def api_keys
+      @api_keys ||= Wavix::APIKeys::Client.new(client: @raw_client)
+    end
+
+    # @return [Wavix::SipTrunks::Client]
+    def sip_trunks
+      @sip_trunks ||= Wavix::SipTrunks::Client.new(client: @raw_client)
+    end
+
+    # @return [Wavix::Cart::Client]
+    def cart
+      @cart ||= Wavix::Cart::Client.new(client: @raw_client)
+    end
+
+    # @return [Wavix::Numbers::Client]
+    def numbers
+      @numbers ||= Wavix::Numbers::Client.new(client: @raw_client)
+    end
+
+    # @return [Wavix::Cdrs::Client]
+    def cdrs
+      @cdrs ||= Wavix::Cdrs::Client.new(client: @raw_client)
+    end
+
+    # @return [Wavix::CallRecording::Client]
+    def call_recording
+      @call_recording ||= Wavix::CallRecording::Client.new(client: @raw_client)
+    end
+
+    # @return [Wavix::SpeechAnalytics::Client]
+    def speech_analytics
+      @speech_analytics ||= Wavix::SpeechAnalytics::Client.new(client: @raw_client)
+    end
+
+    # @return [Wavix::CallWebhooks::Client]
+    def call_webhooks
+      @call_webhooks ||= Wavix::CallWebhooks::Client.new(client: @raw_client)
+    end
+
+    # @return [Wavix::CallControl::Client]
+    def call_control
+      @call_control ||= Wavix::CallControl::Client.new(client: @raw_client)
+    end
+
+    # @return [Wavix::NumberValidator::Client]
+    def number_validator
+      @number_validator ||= Wavix::NumberValidator::Client.new(client: @raw_client)
+    end
+
+    # @return [Wavix::VoiceCampaigns::Client]
+    def voice_campaigns
+      @voice_campaigns ||= Wavix::VoiceCampaigns::Client.new(client: @raw_client)
+    end
+
+    # @return [Wavix::LinkShortener::Client]
+    def link_shortener
+      @link_shortener ||= Wavix::LinkShortener::Client.new(client: @raw_client)
+    end
+
+    # @return [Wavix::Profile::Client]
+    def profile
+      @profile ||= Wavix::Profile::Client.new(client: @raw_client)
+    end
+
+    # @return [Wavix::SubAccounts::Client]
+    def sub_accounts
+      @sub_accounts ||= Wavix::SubAccounts::Client.new(client: @raw_client)
+    end
+
+    # @return [Wavix::SmsAndMms::Client]
+    def sms_and_mms
+      @sms_and_mms ||= Wavix::SmsAndMms::Client.new(client: @raw_client)
+    end
+
+    # @return [Wavix::Billing::Client]
+    def billing
+      @billing ||= Wavix::Billing::Client.new(client: @raw_client)
+    end
+
+    # @return [Wavix::Buy::Client]
+    def buy
+      @buy ||= Wavix::Buy::Client.new(client: @raw_client)
+    end
+
+    # @return [Wavix::TenDlc::Client]
+    def ten_dlc
+      @ten_dlc ||= Wavix::TenDlc::Client.new(client: @raw_client)
+    end
+
+    # @return [Wavix::TwoFa::Client]
+    def two_fa
+      @two_fa ||= Wavix::TwoFa::Client.new(client: @raw_client)
+    end
+
+    # @return [Wavix::Webrtc::Client]
+    def webrtc
+      @webrtc ||= Wavix::Webrtc::Client.new(client: @raw_client)
+    end
+  end
+end

data/lib/wavix/environment.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Wavix
+  class Environment
+    DEFAULT = "https://api.wavix.com"
+  end
+end

data/lib/wavix/errors/api_error.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Errors
+    class ApiError < StandardError
+    end
+  end
+end

data/lib/wavix/errors/client_error.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Errors
+    class ClientError < ResponseError
+    end
+
+    class UnauthorizedError < ClientError
+    end
+
+    class ForbiddenError < ClientError
+    end
+
+    class NotFoundError < ClientError
+    end
+  end
+end

data/lib/wavix/errors/redirect_error.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Errors
+    class RedirectError < ResponseError
+    end
+  end
+end