moonbase-sdk 0.1.0.pre.alpha.1 → 0.1.0.pre.alpha.3

data/rbi/moonbase/models/call.rbi

@@ -10,6 +10,10 @@ module Moonbase
       sig { returns(String) }
       attr_accessor :id
 
+      # Time at which the object was created, as an ISO 8601 timestamp in UTC.
+      sig { returns(Time) }
+      attr_accessor :created_at
+
       # The direction of the call, either `incoming` or `outgoing`.
       sig { returns(Moonbase::Call::Direction::TaggedSymbol) }
       attr_accessor :direction
@@ -26,33 +30,30 @@ module Moonbase
       sig { returns(String) }
       attr_accessor :provider_id
 
-      # The time the call started, as an RFC 3339 timestamp.
+      # The current status of the call.
+      sig { returns(String) }
+      attr_accessor :provider_status
+
+      # The time the call started, as an ISO 8601 timestamp in UTC.
       sig { returns(Time) }
       attr_accessor :start_at
 
-      # The current status of the call.
-      sig { returns(Moonbase::Call::Status::TaggedSymbol) }
-      attr_accessor :status
-
       # String representing the object’s type. Always `call` for this object.
       sig { returns(Symbol) }
       attr_accessor :type
 
-      # The time the call was answered, if available, as an RFC 3339 timestamp.
+      # Time at which the object was last updated, as an ISO 8601 timestamp in UTC.
+      sig { returns(Time) }
+      attr_accessor :updated_at
+
+      # The time the call was answered, if available, as an ISO 8601 timestamp in UTC.
       sig { returns(T.nilable(Time)) }
       attr_reader :answered_at
 
       sig { params(answered_at: Time).void }
       attr_writer :answered_at
 
-      # Time at which the object was created, as an RFC 3339 timestamp.
-      sig { returns(T.nilable(Time)) }
-      attr_reader :created_at
-
-      sig { params(created_at: Time).void }
-      attr_writer :created_at
-
-      # The time the call ended, if available, as an RFC 3339 timestamp.
+      # The time the call ended, if available, as an ISO 8601 timestamp in UTC.
       sig { returns(T.nilable(Time)) }
       attr_reader :end_at
 
@@ -66,35 +67,30 @@ module Moonbase
       sig { params(provider_metadata: T::Hash[Symbol, T.anything]).void }
       attr_writer :provider_metadata
 
-      # Time at which the object was last updated, as an RFC 3339 timestamp.
-      sig { returns(T.nilable(Time)) }
-      attr_reader :updated_at
-
-      sig { params(updated_at: Time).void }
-      attr_writer :updated_at
-
       # The Call object represents a phone call that has been logged in the system. It
       # contains details about the participants, timing, and outcome of the call.
       sig do
         params(
           id: String,
+          created_at: Time,
           direction: Moonbase::Call::Direction::OrSymbol,
           participants: T::Array[Moonbase::Call::Participant::OrHash],
           provider: String,
           provider_id: String,
+          provider_status: String,
           start_at: Time,
-          status: Moonbase::Call::Status::OrSymbol,
+          updated_at: Time,
           answered_at: Time,
-          created_at: Time,
           end_at: Time,
           provider_metadata: T::Hash[Symbol, T.anything],
-          updated_at: Time,
           type: Symbol
         ).returns(T.attached_class)
       end
       def self.new(
         # Unique identifier for the object.
         id:,
+        # Time at which the object was created, as an ISO 8601 timestamp in UTC.
+        created_at:,
         # The direction of the call, either `incoming` or `outgoing`.
         direction:,
         # The participants involved in the call.
@@ -103,20 +99,18 @@ module Moonbase
         provider:,
         # The unique identifier for the call from the provider's system.
         provider_id:,
-        # The time the call started, as an RFC 3339 timestamp.
-        start_at:,
         # The current status of the call.
-        status:,
-        # The time the call was answered, if available, as an RFC 3339 timestamp.
+        provider_status:,
+        # The time the call started, as an ISO 8601 timestamp in UTC.
+        start_at:,
+        # Time at which the object was last updated, as an ISO 8601 timestamp in UTC.
+        updated_at:,
+        # The time the call was answered, if available, as an ISO 8601 timestamp in UTC.
         answered_at: nil,
-        # Time at which the object was created, as an RFC 3339 timestamp.
-        created_at: nil,
-        # The time the call ended, if available, as an RFC 3339 timestamp.
+        # The time the call ended, if available, as an ISO 8601 timestamp in UTC.
         end_at: nil,
         # A hash of additional metadata from the provider.
         provider_metadata: nil,
-        # Time at which the object was last updated, as an RFC 3339 timestamp.
-        updated_at: nil,
         # String representing the object’s type. Always `call` for this object.
         type: :call
       )
@@ -126,18 +120,18 @@ module Moonbase
         override.returns(
           {
             id: String,
+            created_at: Time,
             direction: Moonbase::Call::Direction::TaggedSymbol,
             participants: T::Array[Moonbase::Call::Participant],
             provider: String,
             provider_id: String,
+            provider_status: String,
             start_at: Time,
-            status: Moonbase::Call::Status::TaggedSymbol,
             type: Symbol,
+            updated_at: Time,
             answered_at: Time,
-            created_at: Time,
             end_at: Time,
-            provider_metadata: T::Hash[Symbol, T.anything],
-            updated_at: Time
+            provider_metadata: T::Hash[Symbol, T.anything]
           }
         )
       end
@@ -179,23 +173,24 @@ module Moonbase
         sig { returns(Moonbase::Call::Participant::Role::TaggedSymbol) }
         attr_accessor :role
 
-        # String representing the object’s type. Always `participant` for this object.
+        # String representing the object’s type. Always `call_participant` for this
+        # object.
         sig { returns(Symbol) }
         attr_accessor :type
 
-        # Time at which the object was created, as an RFC 3339 timestamp.
-        sig { returns(T.nilable(Time)) }
-        attr_reader :created_at
+        # A lightweight reference to another resource.
+        sig { returns(T.nilable(Moonbase::Pointer)) }
+        attr_reader :organization
 
-        sig { params(created_at: Time).void }
-        attr_writer :created_at
+        sig { params(organization: Moonbase::Pointer::OrHash).void }
+        attr_writer :organization
 
-        # Time at which the object was last updated, as an RFC 3339 timestamp.
-        sig { returns(T.nilable(Time)) }
-        attr_reader :updated_at
+        # A lightweight reference to another resource.
+        sig { returns(T.nilable(Moonbase::Pointer)) }
+        attr_reader :person
 
-        sig { params(updated_at: Time).void }
-        attr_writer :updated_at
+        sig { params(person: Moonbase::Pointer::OrHash).void }
+        attr_writer :person
 
         # Represents a participant in a call.
         sig do
@@ -203,8 +198,8 @@ module Moonbase
             id: String,
             phone: String,
             role: Moonbase::Call::Participant::Role::OrSymbol,
-            created_at: Time,
-            updated_at: Time,
+            organization: Moonbase::Pointer::OrHash,
+            person: Moonbase::Pointer::OrHash,
             type: Symbol
           ).returns(T.attached_class)
         end
@@ -215,12 +210,13 @@ module Moonbase
           phone:,
           # The role of the participant in the call. Can be `caller`, `callee`, or `other`.
           role:,
-          # Time at which the object was created, as an RFC 3339 timestamp.
-          created_at: nil,
-          # Time at which the object was last updated, as an RFC 3339 timestamp.
-          updated_at: nil,
-          # String representing the object’s type. Always `participant` for this object.
-          type: :participant
+          # A lightweight reference to another resource.
+          organization: nil,
+          # A lightweight reference to another resource.
+          person: nil,
+          # String representing the object’s type. Always `call_participant` for this
+          # object.
+          type: :call_participant
         )
         end
 
@@ -231,8 +227,8 @@ module Moonbase
               phone: String,
               role: Moonbase::Call::Participant::Role::TaggedSymbol,
               type: Symbol,
-              created_at: Time,
-              updated_at: Time
+              organization: Moonbase::Pointer,
+              person: Moonbase::Pointer
             }
           )
         end
@@ -262,32 +258,6 @@ module Moonbase
           end
         end
       end
-
-      # The current status of the call.
-      module Status
-        extend Moonbase::Internal::Type::Enum
-
-        TaggedSymbol = T.type_alias { T.all(Symbol, Moonbase::Call::Status) }
-        OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-        QUEUED = T.let(:queued, Moonbase::Call::Status::TaggedSymbol)
-        INITIATED = T.let(:initiated, Moonbase::Call::Status::TaggedSymbol)
-        RINGING = T.let(:ringing, Moonbase::Call::Status::TaggedSymbol)
-        IN_PROGRESS = T.let(:in_progress, Moonbase::Call::Status::TaggedSymbol)
-        COMPLETED = T.let(:completed, Moonbase::Call::Status::TaggedSymbol)
-        BUSY = T.let(:busy, Moonbase::Call::Status::TaggedSymbol)
-        FAILED = T.let(:failed, Moonbase::Call::Status::TaggedSymbol)
-        NO_ANSWER = T.let(:no_answer, Moonbase::Call::Status::TaggedSymbol)
-        CANCELED = T.let(:canceled, Moonbase::Call::Status::TaggedSymbol)
-        MISSED = T.let(:missed, Moonbase::Call::Status::TaggedSymbol)
-        ANSWERED = T.let(:answered, Moonbase::Call::Status::TaggedSymbol)
-        FORWARDED = T.let(:forwarded, Moonbase::Call::Status::TaggedSymbol)
-        ABANDONED = T.let(:abandoned, Moonbase::Call::Status::TaggedSymbol)
-
-        sig { override.returns(T::Array[Moonbase::Call::Status::TaggedSymbol]) }
-        def self.values
-        end
-      end
     end
   end
 end

data/rbi/moonbase/models/call_create_params.rbi

@@ -27,22 +27,22 @@ module Moonbase
       sig { returns(String) }
       attr_accessor :provider_id
 
-      # The time the call started, as an RFC 3339 timestamp.
+      # The status of the call.
+      sig { returns(String) }
+      attr_accessor :provider_status
+
+      # The time the call started, as an ISO 8601 timestamp in UTC.
       sig { returns(Time) }
       attr_accessor :start_at
 
-      # The status of the call.
-      sig { returns(Moonbase::CallCreateParams::Status::OrSymbol) }
-      attr_accessor :status
-
-      # The time the call was answered, as an RFC 3339 timestamp.
+      # The time the call was answered, as an ISO 8601 timestamp in UTC.
       sig { returns(T.nilable(Time)) }
       attr_reader :answered_at
 
       sig { params(answered_at: Time).void }
       attr_writer :answered_at
 
-      # The time the call ended, as an RFC 3339 timestamp.
+      # The time the call ended, as an ISO 8601 timestamp in UTC.
       sig { returns(T.nilable(Time)) }
       attr_reader :end_at
 
@@ -56,6 +56,28 @@ module Moonbase
       sig { params(provider_metadata: T::Hash[Symbol, T.anything]).void }
       attr_writer :provider_metadata
 
+      # Any recordings associated with the call.
+      sig do
+        returns(T.nilable(T::Array[Moonbase::CallCreateParams::Recording]))
+      end
+      attr_reader :recordings
+
+      sig do
+        params(
+          recordings: T::Array[Moonbase::CallCreateParams::Recording::OrHash]
+        ).void
+      end
+      attr_writer :recordings
+
+      # A transcript of the call.
+      sig { returns(T.nilable(Moonbase::CallCreateParams::Transcript)) }
+      attr_reader :transcript
+
+      sig do
+        params(transcript: Moonbase::CallCreateParams::Transcript::OrHash).void
+      end
+      attr_writer :transcript
+
       sig do
         params(
           direction: Moonbase::CallCreateParams::Direction::OrSymbol,
@@ -63,11 +85,13 @@ module Moonbase
             T::Array[Moonbase::CallCreateParams::Participant::OrHash],
           provider: String,
           provider_id: String,
+          provider_status: String,
           start_at: Time,
-          status: Moonbase::CallCreateParams::Status::OrSymbol,
           answered_at: Time,
           end_at: Time,
           provider_metadata: T::Hash[Symbol, T.anything],
+          recordings: T::Array[Moonbase::CallCreateParams::Recording::OrHash],
+          transcript: Moonbase::CallCreateParams::Transcript::OrHash,
           request_options: Moonbase::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
@@ -80,16 +104,20 @@ module Moonbase
         provider:,
         # The unique identifier for the call from the provider's system.
         provider_id:,
-        # The time the call started, as an RFC 3339 timestamp.
-        start_at:,
         # The status of the call.
-        status:,
-        # The time the call was answered, as an RFC 3339 timestamp.
+        provider_status:,
+        # The time the call started, as an ISO 8601 timestamp in UTC.
+        start_at:,
+        # The time the call was answered, as an ISO 8601 timestamp in UTC.
         answered_at: nil,
-        # The time the call ended, as an RFC 3339 timestamp.
+        # The time the call ended, as an ISO 8601 timestamp in UTC.
         end_at: nil,
         # A hash of additional metadata from the provider.
         provider_metadata: nil,
+        # Any recordings associated with the call.
+        recordings: nil,
+        # A transcript of the call.
+        transcript: nil,
         request_options: {}
       )
       end
@@ -101,11 +129,13 @@ module Moonbase
             participants: T::Array[Moonbase::CallCreateParams::Participant],
             provider: String,
             provider_id: String,
+            provider_status: String,
             start_at: Time,
-            status: Moonbase::CallCreateParams::Status::OrSymbol,
             answered_at: Time,
             end_at: Time,
             provider_metadata: T::Hash[Symbol, T.anything],
+            recordings: T::Array[Moonbase::CallCreateParams::Recording],
+            transcript: Moonbase::CallCreateParams::Transcript,
             request_options: Moonbase::RequestOptions
           }
         )
@@ -216,46 +246,145 @@ module Moonbase
         end
       end
 
-      # The status of the call.
-      module Status
-        extend Moonbase::Internal::Type::Enum
+      class Recording < Moonbase::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Moonbase::CallCreateParams::Recording,
+              Moonbase::Internal::AnyHash
+            )
+          end
 
-        TaggedSymbol =
-          T.type_alias { T.all(Symbol, Moonbase::CallCreateParams::Status) }
-        OrSymbol = T.type_alias { T.any(Symbol, String) }
+        # The content type of the recording. Note that only `audio/mpeg` is supported at
+        # this time.
+        sig { returns(String) }
+        attr_accessor :content_type
 
-        QUEUED =
-          T.let(:queued, Moonbase::CallCreateParams::Status::TaggedSymbol)
-        INITIATED =
-          T.let(:initiated, Moonbase::CallCreateParams::Status::TaggedSymbol)
-        RINGING =
-          T.let(:ringing, Moonbase::CallCreateParams::Status::TaggedSymbol)
-        IN_PROGRESS =
-          T.let(:in_progress, Moonbase::CallCreateParams::Status::TaggedSymbol)
-        COMPLETED =
-          T.let(:completed, Moonbase::CallCreateParams::Status::TaggedSymbol)
-        BUSY = T.let(:busy, Moonbase::CallCreateParams::Status::TaggedSymbol)
-        FAILED =
-          T.let(:failed, Moonbase::CallCreateParams::Status::TaggedSymbol)
-        NO_ANSWER =
-          T.let(:no_answer, Moonbase::CallCreateParams::Status::TaggedSymbol)
-        CANCELED =
-          T.let(:canceled, Moonbase::CallCreateParams::Status::TaggedSymbol)
-        MISSED =
-          T.let(:missed, Moonbase::CallCreateParams::Status::TaggedSymbol)
-        ANSWERED =
-          T.let(:answered, Moonbase::CallCreateParams::Status::TaggedSymbol)
-        FORWARDED =
-          T.let(:forwarded, Moonbase::CallCreateParams::Status::TaggedSymbol)
-        ABANDONED =
-          T.let(:abandoned, Moonbase::CallCreateParams::Status::TaggedSymbol)
+        # The unique identifier for the recording from the provider's system.
+        sig { returns(String) }
+        attr_accessor :provider_id
+
+        # The URL pointing to the recording.
+        sig { returns(String) }
+        attr_accessor :url
+
+        # Parameters for creating a `CallRecording` object.
+        sig do
+          params(
+            content_type: String,
+            provider_id: String,
+            url: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The content type of the recording. Note that only `audio/mpeg` is supported at
+          # this time.
+          content_type:,
+          # The unique identifier for the recording from the provider's system.
+          provider_id:,
+          # The URL pointing to the recording.
+          url:
+        )
+        end
 
         sig do
           override.returns(
-            T::Array[Moonbase::CallCreateParams::Status::TaggedSymbol]
+            { content_type: String, provider_id: String, url: String }
           )
         end
-        def self.values
+        def to_hash
+        end
+      end
+
+      class Transcript < Moonbase::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Moonbase::CallCreateParams::Transcript,
+              Moonbase::Internal::AnyHash
+            )
+          end
+
+        # A list of cues that identify the text spoken in specific time slices of the
+        # call.
+        sig { returns(T::Array[Moonbase::CallCreateParams::Transcript::Cue]) }
+        attr_accessor :cues
+
+        # A transcript of the call.
+        sig do
+          params(
+            cues: T::Array[Moonbase::CallCreateParams::Transcript::Cue::OrHash]
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # A list of cues that identify the text spoken in specific time slices of the
+          # call.
+          cues:
+        )
+        end
+
+        sig do
+          override.returns(
+            { cues: T::Array[Moonbase::CallCreateParams::Transcript::Cue] }
+          )
+        end
+        def to_hash
+        end
+
+        class Cue < Moonbase::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Moonbase::CallCreateParams::Transcript::Cue,
+                Moonbase::Internal::AnyHash
+              )
+            end
+
+          # The start time of the slice, in fractional seconds from the start of the call.
+          sig { returns(Float) }
+          attr_accessor :from
+
+          # The E.164 formatted phone number of the speaker.
+          sig { returns(String) }
+          attr_accessor :speaker
+
+          # The text spoken during the slice.
+          sig { returns(String) }
+          attr_accessor :text
+
+          # The end time of the slice, in fractional seconds from the start of the call.
+          sig { returns(Float) }
+          attr_accessor :to
+
+          # Parameters for creating a `CallTranscriptCue` object to capture the text spoken
+          # in a specific time slice.
+          sig do
+            params(
+              from: Float,
+              speaker: String,
+              text: String,
+              to: Float
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # The start time of the slice, in fractional seconds from the start of the call.
+            from:,
+            # The E.164 formatted phone number of the speaker.
+            speaker:,
+            # The text spoken during the slice.
+            text:,
+            # The end time of the slice, in fractional seconds from the start of the call.
+            to:
+          )
+          end
+
+          sig do
+            override.returns(
+              { from: Float, speaker: String, text: String, to: Float }
+            )
+          end
+          def to_hash
+          end
         end
       end
     end