telnyx 5.169.0 → 5.170.0

data/rbi/telnyx/models/ai/memory/namespaces/profile_remember_response.rbi

@@ -0,0 +1,107 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AI
+      module Memory
+        module Namespaces
+          class ProfileRememberResponse < Telnyx::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Telnyx::Models::AI::Memory::Namespaces::ProfileRememberResponse,
+                  Telnyx::Internal::AnyHash
+                )
+              end
+
+            sig do
+              returns(
+                Telnyx::Models::AI::Memory::Namespaces::ProfileRememberResponse::Data
+              )
+            end
+            attr_reader :data
+
+            sig do
+              params(
+                data:
+                  Telnyx::Models::AI::Memory::Namespaces::ProfileRememberResponse::Data::OrHash
+              ).void
+            end
+            attr_writer :data
+
+            sig do
+              params(
+                data:
+                  Telnyx::Models::AI::Memory::Namespaces::ProfileRememberResponse::Data::OrHash
+              ).returns(T.attached_class)
+            end
+            def self.new(data:)
+            end
+
+            sig do
+              override.returns(
+                {
+                  data:
+                    Telnyx::Models::AI::Memory::Namespaces::ProfileRememberResponse::Data
+                }
+              )
+            end
+            def to_hash
+            end
+
+            class Data < Telnyx::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    Telnyx::Models::AI::Memory::Namespaces::ProfileRememberResponse::Data,
+                    Telnyx::Internal::AnyHash
+                  )
+                end
+
+              sig { returns(String) }
+              attr_accessor :operation_id
+
+              sig { returns(String) }
+              attr_accessor :profile_id
+
+              # Identifies one source within its profile: an ingested session, or one remembered
+              # fact. Returned by `ingest` and `remember` when the write is accepted.
+              # Re-ingesting a session keeps its source id.
+              sig { returns(String) }
+              attr_accessor :source_id
+
+              sig do
+                params(
+                  operation_id: String,
+                  profile_id: String,
+                  source_id: String
+                ).returns(T.attached_class)
+              end
+              def self.new(
+                operation_id:,
+                profile_id:,
+                # Identifies one source within its profile: an ingested session, or one remembered
+                # fact. Returned by `ingest` and `remember` when the write is accepted.
+                # Re-ingesting a session keeps its source id.
+                source_id:
+              )
+              end
+
+              sig do
+                override.returns(
+                  {
+                    operation_id: String,
+                    profile_id: String,
+                    source_id: String
+                  }
+                )
+              end
+              def to_hash
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/ai/memory/namespaces/profile_retrieve_summary_params.rbi

@@ -0,0 +1,58 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AI
+      module Memory
+        module Namespaces
+          class ProfileRetrieveSummaryParams < Telnyx::Internal::Type::BaseModel
+            extend Telnyx::Internal::Type::RequestParameters::Converter
+            include Telnyx::Internal::Type::RequestParameters
+
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Telnyx::AI::Memory::Namespaces::ProfileRetrieveSummaryParams,
+                  Telnyx::Internal::AnyHash
+                )
+              end
+
+            # The namespace. `default` exists for every organization.
+            sig { returns(String) }
+            attr_accessor :namespace
+
+            sig { returns(String) }
+            attr_accessor :profile_id
+
+            sig do
+              params(
+                namespace: String,
+                profile_id: String,
+                request_options: Telnyx::RequestOptions::OrHash
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              # The namespace. `default` exists for every organization.
+              namespace:,
+              profile_id:,
+              request_options: {}
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  namespace: String,
+                  profile_id: String,
+                  request_options: Telnyx::RequestOptions
+                }
+              )
+            end
+            def to_hash
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/ai/memory/namespaces/profile_retrieve_summary_response.rbi

@@ -0,0 +1,119 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AI
+      module Memory
+        module Namespaces
+          class ProfileRetrieveSummaryResponse < Telnyx::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Telnyx::Models::AI::Memory::Namespaces::ProfileRetrieveSummaryResponse,
+                  Telnyx::Internal::AnyHash
+                )
+              end
+
+            sig do
+              returns(
+                Telnyx::Models::AI::Memory::Namespaces::ProfileRetrieveSummaryResponse::Data
+              )
+            end
+            attr_reader :data
+
+            sig do
+              params(
+                data:
+                  Telnyx::Models::AI::Memory::Namespaces::ProfileRetrieveSummaryResponse::Data::OrHash
+              ).void
+            end
+            attr_writer :data
+
+            sig do
+              params(
+                data:
+                  Telnyx::Models::AI::Memory::Namespaces::ProfileRetrieveSummaryResponse::Data::OrHash
+              ).returns(T.attached_class)
+            end
+            def self.new(data:)
+            end
+
+            sig do
+              override.returns(
+                {
+                  data:
+                    Telnyx::Models::AI::Memory::Namespaces::ProfileRetrieveSummaryResponse::Data
+                }
+              )
+            end
+            def to_hash
+            end
+
+            class Data < Telnyx::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    Telnyx::Models::AI::Memory::Namespaces::ProfileRetrieveSummaryResponse::Data,
+                    Telnyx::Internal::AnyHash
+                  )
+                end
+
+              # Whether newer memories have arrived since the summary was generated. The summary
+              # is regenerated in the background, so a true here is ordinary and the summary is
+              # still usable.
+              sig { returns(T::Boolean) }
+              attr_accessor :is_stale
+
+              sig { returns(String) }
+              attr_accessor :profile_id
+
+              # When the summary was last generated. Null while none is ready.
+              sig { returns(T.nilable(String)) }
+              attr_accessor :generated_at
+
+              # The precomputed summary, ready to place in an assistant's context at the start
+              # of a session.
+              sig { returns(T.nilable(String)) }
+              attr_accessor :text
+
+              sig do
+                params(
+                  is_stale: T::Boolean,
+                  profile_id: String,
+                  generated_at: T.nilable(String),
+                  text: T.nilable(String)
+                ).returns(T.attached_class)
+              end
+              def self.new(
+                # Whether newer memories have arrived since the summary was generated. The summary
+                # is regenerated in the background, so a true here is ordinary and the summary is
+                # still usable.
+                is_stale:,
+                profile_id:,
+                # When the summary was last generated. Null while none is ready.
+                generated_at: nil,
+                # The precomputed summary, ready to place in an assistant's context at the start
+                # of a session.
+                text: nil
+              )
+              end
+
+              sig do
+                override.returns(
+                  {
+                    is_stale: T::Boolean,
+                    profile_id: String,
+                    generated_at: T.nilable(String),
+                    text: T.nilable(String)
+                  }
+                )
+              end
+              def to_hash
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/ai/memory/namespaces/profiles/memory_list_params.rbi

@@ -0,0 +1,102 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AI
+      module Memory
+        module Namespaces
+          module Profiles
+            class MemoryListParams < Telnyx::Internal::Type::BaseModel
+              extend Telnyx::Internal::Type::RequestParameters::Converter
+              include Telnyx::Internal::Type::RequestParameters
+
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    Telnyx::AI::Memory::Namespaces::Profiles::MemoryListParams,
+                    Telnyx::Internal::AnyHash
+                  )
+                end
+
+              sig { returns(String) }
+              attr_accessor :namespace
+
+              sig { returns(String) }
+              attr_accessor :profile_id
+
+              # The page to return, counting from 1. Bounded in depth: (page[number] - 1) \*
+              # page[size] may be at most 10000.
+              sig { returns(T.nilable(Integer)) }
+              attr_reader :page_number
+
+              sig { params(page_number: Integer).void }
+              attr_writer :page_number
+
+              # How many results a page holds.
+              sig { returns(T.nilable(Integer)) }
+              attr_reader :page_size
+
+              sig { params(page_size: Integer).void }
+              attr_writer :page_size
+
+              # An ingested session, by the `session_id` it was ingested with. Narrows the
+              # request to the source that session was stored as.
+              sig { returns(T.nilable(String)) }
+              attr_accessor :session_id
+
+              # Narrows the listing to the memories extracted from one source, a remembered fact
+              # as well as a session. Pass this or `session_id`, not both.
+              sig { returns(T.nilable(String)) }
+              attr_accessor :source_id
+
+              sig do
+                params(
+                  namespace: String,
+                  profile_id: String,
+                  page_number: Integer,
+                  page_size: Integer,
+                  session_id: T.nilable(String),
+                  source_id: T.nilable(String),
+                  request_options: Telnyx::RequestOptions::OrHash
+                ).returns(T.attached_class)
+              end
+              def self.new(
+                namespace:,
+                profile_id:,
+                # The page to return, counting from 1. Bounded in depth: (page[number] - 1) \*
+                # page[size] may be at most 10000.
+                page_number: nil,
+                # How many results a page holds.
+                page_size: nil,
+                # An ingested session, by the `session_id` it was ingested with. Narrows the
+                # request to the source that session was stored as.
+                session_id: nil,
+                # Narrows the listing to the memories extracted from one source, a remembered fact
+                # as well as a session. Pass this or `session_id`, not both.
+                source_id: nil,
+                request_options: {}
+              )
+              end
+
+              sig do
+                override.returns(
+                  {
+                    namespace: String,
+                    profile_id: String,
+                    page_number: Integer,
+                    page_size: Integer,
+                    session_id: T.nilable(String),
+                    source_id: T.nilable(String),
+                    request_options: Telnyx::RequestOptions
+                  }
+                )
+              end
+              def to_hash
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/ai/memory/namespaces/profiles/memory_list_response.rbi

@@ -0,0 +1,72 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AI
+      module Memory
+        module Namespaces
+          module Profiles
+            class MemoryListResponse < Telnyx::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    Telnyx::Models::AI::Memory::Namespaces::Profiles::MemoryListResponse,
+                    Telnyx::Internal::AnyHash
+                  )
+                end
+
+              sig { returns(String) }
+              attr_accessor :id
+
+              # The source this memory was extracted from. Set for a fact, which comes from
+              # exactly one source; null for a memory derived from other memories. Read it with
+              # `GET .../sources/{source_id}`. A source deleted a moment ago can still be named
+              # here, and then answers 404.
+              sig { returns(T.nilable(String)) }
+              attr_accessor :source_id
+
+              sig { returns(String) }
+              attr_accessor :text
+
+              sig { returns(T.nilable(String)) }
+              attr_accessor :recorded_at
+
+              sig do
+                params(
+                  id: String,
+                  source_id: T.nilable(String),
+                  text: String,
+                  recorded_at: T.nilable(String)
+                ).returns(T.attached_class)
+              end
+              def self.new(
+                id:,
+                # The source this memory was extracted from. Set for a fact, which comes from
+                # exactly one source; null for a memory derived from other memories. Read it with
+                # `GET .../sources/{source_id}`. A source deleted a moment ago can still be named
+                # here, and then answers 404.
+                source_id:,
+                text:,
+                recorded_at: nil
+              )
+              end
+
+              sig do
+                override.returns(
+                  {
+                    id: String,
+                    source_id: T.nilable(String),
+                    text: String,
+                    recorded_at: T.nilable(String)
+                  }
+                )
+              end
+              def to_hash
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/ai/memory/namespaces/profiles/memory_retrieve_params.rbi

@@ -0,0 +1,70 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AI
+      module Memory
+        module Namespaces
+          module Profiles
+            class MemoryRetrieveParams < Telnyx::Internal::Type::BaseModel
+              extend Telnyx::Internal::Type::RequestParameters::Converter
+              include Telnyx::Internal::Type::RequestParameters
+
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    Telnyx::AI::Memory::Namespaces::Profiles::MemoryRetrieveParams,
+                    Telnyx::Internal::AnyHash
+                  )
+                end
+
+              # The namespace. `default` exists for every organization.
+              sig { returns(String) }
+              attr_accessor :namespace
+
+              # The profile: your identifier for the user, caller or agent this memory is about.
+              sig { returns(String) }
+              attr_accessor :profile_id
+
+              # A memory's id, as `recall` and the listing return it.
+              sig { returns(String) }
+              attr_accessor :memory_id
+
+              sig do
+                params(
+                  namespace: String,
+                  profile_id: String,
+                  memory_id: String,
+                  request_options: Telnyx::RequestOptions::OrHash
+                ).returns(T.attached_class)
+              end
+              def self.new(
+                # The namespace. `default` exists for every organization.
+                namespace:,
+                # The profile: your identifier for the user, caller or agent this memory is about.
+                profile_id:,
+                # A memory's id, as `recall` and the listing return it.
+                memory_id:,
+                request_options: {}
+              )
+              end
+
+              sig do
+                override.returns(
+                  {
+                    namespace: String,
+                    profile_id: String,
+                    memory_id: String,
+                    request_options: Telnyx::RequestOptions
+                  }
+                )
+              end
+              def to_hash
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/ai/memory/namespaces/profiles/memory_retrieve_response.rbi

@@ -0,0 +1,129 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AI
+      module Memory
+        module Namespaces
+          module Profiles
+            class MemoryRetrieveResponse < Telnyx::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    Telnyx::Models::AI::Memory::Namespaces::Profiles::MemoryRetrieveResponse,
+                    Telnyx::Internal::AnyHash
+                  )
+                end
+
+              sig do
+                returns(
+                  Telnyx::Models::AI::Memory::Namespaces::Profiles::MemoryRetrieveResponse::Data
+                )
+              end
+              attr_reader :data
+
+              sig do
+                params(
+                  data:
+                    Telnyx::Models::AI::Memory::Namespaces::Profiles::MemoryRetrieveResponse::Data::OrHash
+                ).void
+              end
+              attr_writer :data
+
+              sig do
+                params(
+                  data:
+                    Telnyx::Models::AI::Memory::Namespaces::Profiles::MemoryRetrieveResponse::Data::OrHash
+                ).returns(T.attached_class)
+              end
+              def self.new(data:)
+              end
+
+              sig do
+                override.returns(
+                  {
+                    data:
+                      Telnyx::Models::AI::Memory::Namespaces::Profiles::MemoryRetrieveResponse::Data
+                  }
+                )
+              end
+              def to_hash
+              end
+
+              class Data < Telnyx::Internal::Type::BaseModel
+                OrHash =
+                  T.type_alias do
+                    T.any(
+                      Telnyx::Models::AI::Memory::Namespaces::Profiles::MemoryRetrieveResponse::Data,
+                      Telnyx::Internal::AnyHash
+                    )
+                  end
+
+                sig { returns(String) }
+                attr_accessor :id
+
+                # The ids of the memories this one was derived from. Read each with
+                # `GET .../memories/{memory_id}` to reach its `source_id`. Set for a derived
+                # memory; null for a fact.
+                sig { returns(T.nilable(T::Array[String])) }
+                attr_accessor :derived_from
+
+                # The source this memory was extracted from. Set for a fact, which comes from
+                # exactly one source; null for a memory derived from other memories. Read it with
+                # `GET .../sources/{source_id}`. A source deleted a moment ago can still be named
+                # here, and then answers 404.
+                sig { returns(T.nilable(String)) }
+                attr_accessor :source_id
+
+                sig { returns(String) }
+                attr_accessor :text
+
+                sig { returns(T.nilable(String)) }
+                attr_accessor :recorded_at
+
+                sig do
+                  params(
+                    id: String,
+                    derived_from: T.nilable(T::Array[String]),
+                    source_id: T.nilable(String),
+                    text: String,
+                    recorded_at: T.nilable(String)
+                  ).returns(T.attached_class)
+                end
+                def self.new(
+                  id:,
+                  # The ids of the memories this one was derived from. Read each with
+                  # `GET .../memories/{memory_id}` to reach its `source_id`. Set for a derived
+                  # memory; null for a fact.
+                  derived_from:,
+                  # The source this memory was extracted from. Set for a fact, which comes from
+                  # exactly one source; null for a memory derived from other memories. Read it with
+                  # `GET .../sources/{source_id}`. A source deleted a moment ago can still be named
+                  # here, and then answers 404.
+                  source_id:,
+                  text:,
+                  recorded_at: nil
+                )
+                end
+
+                sig do
+                  override.returns(
+                    {
+                      id: String,
+                      derived_from: T.nilable(T::Array[String]),
+                      source_id: T.nilable(String),
+                      text: String,
+                      recorded_at: T.nilable(String)
+                    }
+                  )
+                end
+                def to_hash
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end