wavix-ruby-sdk 1.0.0

data/lib/wavix/types/cdr_transcription_response.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    class CdrTranscriptionResponse < Internal::Types::Model
+      field :transcript, -> { Internal::Types::Hash[String, String] }, optional: false, nullable: false
+
+      field :turns, -> { Internal::Types::Array[Wavix::Types::TranscriptTurn] }, optional: false, nullable: false
+
+      field :uuid, -> { String }, optional: false, nullable: false
+
+      field :language, -> { Wavix::Types::TranscriptionLanguage }, optional: false, nullable: false
+
+      field :duration, -> { Integer }, optional: false, nullable: false
+
+      field :charge, -> { String }, optional: false, nullable: false
+
+      field :status, -> { Wavix::Types::TranscriptionStatus }, optional: false, nullable: false
+
+      field :transcription_date, -> { String }, optional: false, nullable: false
+
+      field :call_date, -> { String }, optional: false, nullable: false
+
+      field :call_uuid, -> { String }, optional: false, nullable: false
+
+      field :call_score, -> { String }, optional: false, nullable: false
+
+      field :call_summary, -> { String }, optional: false, nullable: false
+    end
+  end
+end

data/lib/wavix/types/cdr_transcription_search_response.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    class CdrTranscriptionSearchResponse < Internal::Types::Model
+      field :items, -> { Internal::Types::Array[Wavix::Types::CdrWithTranscription] }, optional: false, nullable: false
+
+      field :pagination, -> { Wavix::Types::Pagination }, optional: false, nullable: false
+    end
+  end
+end

data/lib/wavix/types/cdr_with_transcription.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    # A CDR of a single call with call transcription
+    class CdrWithTranscription < Internal::Types::Model
+      field :answered_by, -> { String }, optional: true, nullable: false
+
+      field :date, -> { String }, optional: false, nullable: false
+
+      field :from, -> { String }, optional: false, nullable: false
+
+      field :to, -> { String }, optional: false, nullable: false
+
+      field :disposition, -> { Wavix::Types::CallDisposition }, optional: false, nullable: false
+
+      field :duration, -> { Integer }, optional: false, nullable: false
+
+      field :destination, -> { String }, optional: false, nullable: false
+
+      field :per_minute, -> { String }, optional: false, nullable: false
+
+      field :charge, -> { String }, optional: false, nullable: false
+
+      field :sip_trunk, -> { String }, optional: true, nullable: false
+
+      field :forward_fee, -> { String }, optional: true, nullable: false
+
+      field :uuid, -> { String }, optional: false, nullable: false
+
+      field :call_id, -> { String }, optional: false, nullable: false
+
+      field :parent_uuid, -> { String }, optional: true, nullable: false
+
+      field :parent_call_id, -> { String }, optional: true, nullable: false
+
+      field :transcription, -> { Wavix::Types::TranscriptionReference }, optional: false, nullable: true
+    end
+  end
+end

data/lib/wavix/types/city.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    class City < Internal::Types::Model
+      field :id, -> { Integer }, optional: false, nullable: false
+
+      field :name, -> { String }, optional: false, nullable: false
+
+      field :area_code, -> { Integer }, optional: false, nullable: false
+    end
+  end
+end

data/lib/wavix/types/city_list_response.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    class CityListResponse < Internal::Types::Model
+      field :cities, -> { Internal::Types::Array[Wavix::Types::City] }, optional: false, nullable: false
+    end
+  end
+end

data/lib/wavix/types/country.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    class Country < Internal::Types::Model
+      field :id, -> { Integer }, optional: false, nullable: false
+
+      field :name, -> { String }, optional: false, nullable: false
+
+      field :has_provinces_or_states, -> { Internal::Types::Boolean }, optional: false, nullable: false
+    end
+  end
+end

data/lib/wavix/types/country_has_no_regions_error_response.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    class CountryHasNoRegionsErrorResponse < Internal::Types::Model
+      field :success, -> { Internal::Types::Boolean }, optional: true, nullable: false
+
+      field :message, -> { String }, optional: true, nullable: false
+    end
+  end
+end

data/lib/wavix/types/country_list_response.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    class CountryListResponse < Internal::Types::Model
+      field :countries, -> { Internal::Types::Array[Wavix::Types::Country] }, optional: false, nullable: false
+    end
+  end
+end

data/lib/wavix/types/document_type.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    class DocumentType < Internal::Types::Model
+      field :id, -> { Integer }, optional: false, nullable: false
+
+      field :name, -> { String }, optional: false, nullable: false
+
+      field :title, -> { String }, optional: false, nullable: false
+    end
+  end
+end

data/lib/wavix/types/document_type_id.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    module DocumentTypeID
+      # DocumentTypeID is an alias for Integer
+
+      # @option str [String]
+      #
+      # @return [untyped]
+      def self.load(str)
+        ::JSON.parse(str)
+      end
+
+      # @option value [untyped]
+      #
+      # @return [String]
+      def self.dump(value)
+        ::JSON.generate(value)
+      end
+    end
+  end
+end

data/lib/wavix/types/file_transcript_response.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    class FileTranscriptResponse < Internal::Types::Model
+      field :channel1, -> { String }, optional: false, nullable: false, api_name: "channel_1"
+
+      field :channel2, -> { String }, optional: false, nullable: false, api_name: "channel_2"
+    end
+  end
+end

data/lib/wavix/types/file_transcript_turn.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    # Transcription `turn` details, including speaker, timestamps, text, and sentiment.
+    class FileTranscriptTurn < Internal::Types::Model
+      field :speaker, -> { String }, optional: false, nullable: false
+
+      field :s, -> { Integer }, optional: false, nullable: false
+
+      field :e, -> { Integer }, optional: false, nullable: false
+
+      field :text, -> { String }, optional: false, nullable: false
+
+      field :sentiment, -> { String }, optional: false, nullable: false
+    end
+  end
+end

data/lib/wavix/types/file_transcription_completed_webhook.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    class FileTranscriptionCompletedWebhook < Internal::Types::Model
+      field :request_id, -> { String }, optional: false, nullable: false
+
+      field :status, -> { String }, optional: false, nullable: false
+
+      field :error, -> { String }, optional: false, nullable: true
+    end
+  end
+end

data/lib/wavix/types/file_transcription_response.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    class FileTranscriptionResponse < Internal::Types::Model
+      field :transcript, -> { Wavix::Types::FileTranscriptResponse }, optional: false, nullable: true
+
+      field :turns, -> { Internal::Types::Array[Wavix::Types::FileTranscriptTurn] }, optional: false, nullable: true
+
+      field :request_id, -> { String }, optional: false, nullable: false
+
+      field :language, -> { Wavix::Types::FileTranscriptionResponseLanguage }, optional: false, nullable: false
+
+      field :duration, -> { Integer }, optional: false, nullable: true
+
+      field :charge, -> { String }, optional: false, nullable: false
+
+      field :status, -> { Wavix::Types::FileTranscriptionResponseStatus }, optional: false, nullable: false
+
+      field :transcription_date, -> { String }, optional: false, nullable: false
+
+      field :transcription_score, -> { String }, optional: false, nullable: true
+
+      field :transcription_summary, -> { String }, optional: false, nullable: true
+
+      field :original_file, -> { String }, optional: false, nullable: false
+    end
+  end
+end

data/lib/wavix/types/file_transcription_response_language.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    module FileTranscriptionResponseLanguage
+      extend Wavix::Internal::Types::Enum
+
+      EN = "en"
+      DE = "de"
+      ES = "es"
+      FR = "fr"
+      IT = "it"
+    end
+  end
+end

data/lib/wavix/types/file_transcription_response_status.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    module FileTranscriptionResponseStatus
+      extend Wavix::Internal::Types::Enum
+
+      COMPLETED = "completed"
+      FAILED = "failed"
+    end
+  end
+end

data/lib/wavix/types/financial_transaction.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    # Financial transaction.
+    class FinancialTransaction < Internal::Types::Model
+      field :id, -> { Integer }, optional: false, nullable: false
+
+      field :date, -> { String }, optional: false, nullable: false
+
+      field :amount, -> { Integer }, optional: false, nullable: false
+
+      field :balance_after, -> { Integer }, optional: false, nullable: false
+
+      field :details, -> { String }, optional: false, nullable: false
+
+      field :status, -> { Wavix::Types::TransactionStatus }, optional: false, nullable: false
+
+      field :type, -> { Integer }, optional: false, nullable: false
+
+      field :show_invoice, -> { Internal::Types::Boolean }, optional: false, nullable: false
+    end
+  end
+end

data/lib/wavix/types/forbidden_error_response.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    class ForbiddenErrorResponse < Internal::Types::Model
+      field :success, -> { Internal::Types::Boolean }, optional: true, nullable: false
+
+      field :message, -> { String }, optional: true, nullable: false
+    end
+  end
+end

data/lib/wavix/types/inbound_call_destination.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    # Inbound call destination
+    class InboundCallDestination < Internal::Types::Model
+      field :id, -> { Integer }, optional: false, nullable: false
+
+      field :destination, -> { String }, optional: false, nullable: false
+
+      field :priority, -> { Integer }, optional: false, nullable: false
+
+      field :transport, -> { Integer }, optional: false, nullable: false
+
+      field :trunk_id, -> { Integer }, optional: false, nullable: true
+
+      field :srtp, -> { Internal::Types::Boolean }, optional: true, nullable: false
+
+      field :trunk_label, -> { String }, optional: false, nullable: true
+    end
+  end
+end

data/lib/wavix/types/inbound_call_transport.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    module InboundCallTransport
+      # InboundCallTransport is an alias for Integer
+
+      # @option str [String]
+      #
+      # @return [untyped]
+      def self.load(str)
+        ::JSON.parse(str)
+      end
+
+      # @option value [untyped]
+      #
+      # @return [String]
+      def self.dump(value)
+        ::JSON.generate(value)
+      end
+    end
+  end
+end

data/lib/wavix/types/inbound_message.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    # An inbound message
+    class InboundMessage < Internal::Types::Model
+      field :message_id, -> { String }, optional: false, nullable: false
+
+      field :from, -> { String }, optional: false, nullable: false
+
+      field :to, -> { String }, optional: false, nullable: false
+
+      field :message_body, -> { Wavix::Types::MessageBody }, optional: false, nullable: false
+
+      field :received_at, -> { String }, optional: false, nullable: false
+    end
+  end
+end

data/lib/wavix/types/invalid_recording.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    # An invalid recording filter response
+    class InvalidRecording < Internal::Types::Model
+      field :dids, -> { Internal::Types::Array[String] }, optional: true, nullable: false
+
+      field :sip_trunks, -> { Internal::Types::Array[String] }, optional: true, nullable: false
+    end
+  end
+end

data/lib/wavix/types/invoice.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    # An account financial statement
+    class Invoice < Internal::Types::Model
+      field :id, -> { Integer }, optional: false, nullable: false
+
+      field :amount, -> { String }, optional: false, nullable: false
+
+      field :from_date, -> { String }, optional: false, nullable: false
+
+      field :to_date, -> { String }, optional: false, nullable: false
+    end
+  end
+end

data/lib/wavix/types/invoice_list_response.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    class InvoiceListResponse < Internal::Types::Model
+      field :is_empty, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+      field :invoices, -> { Internal::Types::Array[Wavix::Types::Invoice] }, optional: false, nullable: false
+
+      field :pagination, -> { Wavix::Types::Pagination }, optional: false, nullable: false
+    end
+  end
+end

data/lib/wavix/types/list_brand_evidence_response.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    class ListBrandEvidenceResponse < Internal::Types::Model
+      field :items, -> { Internal::Types::Array[Wavix::Types::TenDlcBrandEvidence] }, optional: false, nullable: false
+    end
+  end
+end

data/lib/wavix/types/list_sessions_response_item.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    class ListSessionsResponseItem < Internal::Types::Model
+      field :created_at, -> { String }, optional: true, nullable: false
+
+      field :session_id, -> { String }, optional: true, nullable: false
+
+      field :phone_number, -> { String }, optional: true, nullable: false
+
+      field :destination_country, -> { String }, optional: true, nullable: false
+
+      field :status, -> { String }, optional: true, nullable: false
+
+      field :charge, -> { String }, optional: true, nullable: false
+
+      field :service_id, -> { String }, optional: true, nullable: false
+
+      field :service_name, -> { String }, optional: true, nullable: false
+    end
+  end
+end

data/lib/wavix/types/message.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    # SMS or MMS message.
+    class Message < Internal::Types::Model
+      field :message_id, -> { String }, optional: false, nullable: false
+
+      field :message_type, -> { String }, optional: false, nullable: false
+
+      field :from, -> { String }, optional: false, nullable: false
+
+      field :to, -> { String }, optional: false, nullable: false
+
+      field :carrier_fees, -> { String }, optional: true, nullable: false
+
+      field :direction, -> { String }, optional: false, nullable: false
+
+      field :mcc, -> { String }, optional: false, nullable: true
+
+      field :mnc, -> { String }, optional: false, nullable: true
+
+      field :message_body, -> { Wavix::Types::MessageBody }, optional: false, nullable: false
+
+      field :tag, -> { String }, optional: false, nullable: true
+
+      field :status, -> { Wavix::Types::MessageDeliveryStatus }, optional: false, nullable: false
+
+      field :segments, -> { Integer }, optional: false, nullable: false
+
+      field :charge, -> { String }, optional: false, nullable: false
+
+      field :submitted_at, -> { String }, optional: false, nullable: false
+
+      field :sent_at, -> { String }, optional: false, nullable: true
+
+      field :delivered_at, -> { String }, optional: false, nullable: true
+
+      field :error_message, -> { String }, optional: false, nullable: true
+    end
+  end
+end

data/lib/wavix/types/message_body.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    class MessageBody < Internal::Types::Model
+      field :text, -> { String }, optional: false, nullable: false
+
+      field :media, -> { Internal::Types::Array[String] }, optional: false, nullable: true
+    end
+  end
+end

data/lib/wavix/types/message_create_request.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    class MessageCreateRequest < Internal::Types::Model
+      field :from, -> { String }, optional: false, nullable: false
+
+      field :to, -> { String }, optional: false, nullable: false
+
+      field :message_body, -> { Wavix::Types::MessageBody }, optional: false, nullable: false
+
+      field :callback_url, -> { String }, optional: true, nullable: false
+
+      field :validity, -> { Integer }, optional: true, nullable: false
+
+      field :tag, -> { String }, optional: true, nullable: false
+    end
+  end
+end

data/lib/wavix/types/message_delivery_status.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    module MessageDeliveryStatus
+      extend Wavix::Internal::Types::Enum
+
+      ACCEPTED = "accepted"
+      PENDING = "pending"
+      SENT = "sent"
+      DELIVERED = "delivered"
+      UNDELIVERED = "undelivered"
+      EXPIRED = "expired"
+      REJECTED = "rejected"
+      DLR_EXPIRED = "dlr_expired"
+    end
+  end
+end

data/lib/wavix/types/message_list_response.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    class MessageListResponse < Internal::Types::Model
+      field :items, -> { Internal::Types::Array[Wavix::Types::Message] }, optional: false, nullable: false
+
+      field :pagination, -> { Wavix::Types::Pagination }, optional: false, nullable: false
+    end
+  end
+end

data/lib/wavix/types/message_response.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    class MessageResponse < Internal::Types::Model
+      field :message_id, -> { String }, optional: false, nullable: false
+
+      field :message_type, -> { String }, optional: false, nullable: false
+
+      field :from, -> { String }, optional: false, nullable: false
+
+      field :to, -> { String }, optional: false, nullable: false
+
+      field :direction, -> { String }, optional: false, nullable: false
+
+      field :mcc, -> { String }, optional: false, nullable: true
+
+      field :mnc, -> { String }, optional: false, nullable: true
+
+      field :message_body, -> { Wavix::Types::MessageBody }, optional: false, nullable: false
+
+      field :tag, -> { String }, optional: false, nullable: true
+
+      field :status, -> { Wavix::Types::MessageDeliveryStatus }, optional: false, nullable: false
+
+      field :segments, -> { Integer }, optional: false, nullable: false
+
+      field :charge, -> { String }, optional: false, nullable: false
+
+      field :submitted_at, -> { String }, optional: false, nullable: false
+
+      field :sent_at, -> { String }, optional: false, nullable: true
+
+      field :delivered_at, -> { String }, optional: false, nullable: true
+
+      field :error_message, -> { String }, optional: false, nullable: true
+
+      field :carrier_fees, -> { String }, optional: true, nullable: false
+    end
+  end
+end

data/lib/wavix/types/messages_delivery_report.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    # Message delivery report (DLR).
+    class MessagesDeliveryReport < Internal::Types::Model
+      field :message_id, -> { String }, optional: false, nullable: false
+
+      field :message_type, -> { String }, optional: false, nullable: false
+
+      field :from, -> { String }, optional: false, nullable: false
+
+      field :to, -> { String }, optional: false, nullable: false
+
+      field :tag, -> { String }, optional: true, nullable: false
+
+      field :status, -> { Wavix::Types::MessageDeliveryStatus }, optional: false, nullable: false
+
+      field :segments_count, -> { Integer }, optional: false, nullable: false
+
+      field :sent, -> { String }, optional: false, nullable: true
+
+      field :delivered, -> { String }, optional: true, nullable: false
+
+      field :error, -> { String }, optional: true, nullable: false
+
+      field :charge, -> { String }, optional: false, nullable: false
+
+      field :carrier_fees, -> { String }, optional: false, nullable: false
+    end
+  end
+end