telnyx 5.168.0 → 5.170.0

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

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

@@ -0,0 +1,74 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AI
+      module Memory
+        module Namespaces
+          module Profiles
+            class SourceDeleteParams < 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::SourceDeleteParams,
+                    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
+
+              # 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(
+                  namespace: String,
+                  profile_id: String,
+                  source_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:,
+                # 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:,
+                request_options: {}
+              )
+              end
+
+              sig do
+                override.returns(
+                  {
+                    namespace: String,
+                    profile_id: String,
+                    source_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/source_delete_response.rbi

@@ -0,0 +1,117 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AI
+      module Memory
+        module Namespaces
+          module Profiles
+            class SourceDeleteResponse < Telnyx::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    Telnyx::Models::AI::Memory::Namespaces::Profiles::SourceDeleteResponse,
+                    Telnyx::Internal::AnyHash
+                  )
+                end
+
+              sig do
+                returns(
+                  Telnyx::Models::AI::Memory::Namespaces::Profiles::SourceDeleteResponse::Data
+                )
+              end
+              attr_reader :data
+
+              sig do
+                params(
+                  data:
+                    Telnyx::Models::AI::Memory::Namespaces::Profiles::SourceDeleteResponse::Data::OrHash
+                ).void
+              end
+              attr_writer :data
+
+              sig do
+                params(
+                  data:
+                    Telnyx::Models::AI::Memory::Namespaces::Profiles::SourceDeleteResponse::Data::OrHash
+                ).returns(T.attached_class)
+              end
+              def self.new(data:)
+              end
+
+              sig do
+                override.returns(
+                  {
+                    data:
+                      Telnyx::Models::AI::Memory::Namespaces::Profiles::SourceDeleteResponse::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::SourceDeleteResponse::Data,
+                      Telnyx::Internal::AnyHash
+                    )
+                  end
+
+                # Memories the profile held and no longer does, counted before and after across
+                # the whole profile: it includes memories derived from this source together with
+                # others, and anything else the profile lost in between. A report rather than an
+                # audit. The status carries the outcome.
+                sig { returns(Integer) }
+                attr_accessor :memories_deleted
+
+                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(
+                    memories_deleted: Integer,
+                    profile_id: String,
+                    source_id: String
+                  ).returns(T.attached_class)
+                end
+                def self.new(
+                  # Memories the profile held and no longer does, counted before and after across
+                  # the whole profile: it includes memories derived from this source together with
+                  # others, and anything else the profile lost in between. A report rather than an
+                  # audit. The status carries the outcome.
+                  memories_deleted:,
+                  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(
+                    {
+                      memories_deleted: Integer,
+                      profile_id: String,
+                      source_id: String
+                    }
+                  )
+                end
+                def to_hash
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,92 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AI
+      module Memory
+        module Namespaces
+          module Profiles
+            class SourceListParams < 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::SourceListParams,
+                    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
+
+              sig do
+                params(
+                  namespace: String,
+                  profile_id: String,
+                  page_number: Integer,
+                  page_size: Integer,
+                  session_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,
+                request_options: {}
+              )
+              end
+
+              sig do
+                override.returns(
+                  {
+                    namespace: String,
+                    profile_id: String,
+                    page_number: Integer,
+                    page_size: Integer,
+                    session_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/source_retrieve_params.rbi

@@ -0,0 +1,74 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AI
+      module Memory
+        module Namespaces
+          module Profiles
+            class SourceRetrieveParams < 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::SourceRetrieveParams,
+                    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
+
+              # 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(
+                  namespace: String,
+                  profile_id: String,
+                  source_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:,
+                # 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:,
+                request_options: {}
+              )
+              end
+
+              sig do
+                override.returns(
+                  {
+                    namespace: String,
+                    profile_id: String,
+                    source_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/source_retrieve_response.rbi

@@ -0,0 +1,209 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AI
+      module Memory
+        module Namespaces
+          module Profiles
+            class SourceRetrieveResponse < Telnyx::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    Telnyx::Models::AI::Memory::Namespaces::Profiles::SourceRetrieveResponse,
+                    Telnyx::Internal::AnyHash
+                  )
+                end
+
+              sig do
+                returns(
+                  Telnyx::Models::AI::Memory::Namespaces::Profiles::SourceRetrieveResponse::Data
+                )
+              end
+              attr_reader :data
+
+              sig do
+                params(
+                  data:
+                    Telnyx::Models::AI::Memory::Namespaces::Profiles::SourceRetrieveResponse::Data::OrHash
+                ).void
+              end
+              attr_writer :data
+
+              sig do
+                params(
+                  data:
+                    Telnyx::Models::AI::Memory::Namespaces::Profiles::SourceRetrieveResponse::Data::OrHash
+                ).returns(T.attached_class)
+              end
+              def self.new(data:)
+              end
+
+              sig do
+                override.returns(
+                  {
+                    data:
+                      Telnyx::Models::AI::Memory::Namespaces::Profiles::SourceRetrieveResponse::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::SourceRetrieveResponse::Data,
+                      Telnyx::Internal::AnyHash
+                    )
+                  end
+
+                # 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 :id
+
+                # What was stored, in the shape it was sent: an ingested JSON body as JSON, a
+                # string body or a remembered fact as a string. A session ingested before formats
+                # were recorded is returned as the text it was stored as.
+                sig do
+                  returns(
+                    Telnyx::Models::AI::Memory::Namespaces::Profiles::SourceRetrieveResponse::Data::Content::Variants
+                  )
+                end
+                attr_accessor :content
+
+                # Memories extracted from this source. A memory derived from several sources is
+                # not counted here.
+                sig { returns(Integer) }
+                attr_accessor :memory_count
+
+                # The session this source was ingested as. Null for a remembered fact.
+                sig { returns(T.nilable(String)) }
+                attr_accessor :session_id
+
+                # When the source was first stored.
+                sig { returns(T.nilable(String)) }
+                attr_accessor :created_at
+
+                # When the source was last written; re-ingesting moves it.
+                sig { returns(T.nilable(String)) }
+                attr_accessor :updated_at
+
+                sig do
+                  params(
+                    id: String,
+                    content:
+                      Telnyx::Models::AI::Memory::Namespaces::Profiles::SourceRetrieveResponse::Data::Content::Variants,
+                    memory_count: Integer,
+                    session_id: T.nilable(String),
+                    created_at: T.nilable(String),
+                    updated_at: T.nilable(String)
+                  ).returns(T.attached_class)
+                end
+                def self.new(
+                  # 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.
+                  id:,
+                  # What was stored, in the shape it was sent: an ingested JSON body as JSON, a
+                  # string body or a remembered fact as a string. A session ingested before formats
+                  # were recorded is returned as the text it was stored as.
+                  content:,
+                  # Memories extracted from this source. A memory derived from several sources is
+                  # not counted here.
+                  memory_count:,
+                  # The session this source was ingested as. Null for a remembered fact.
+                  session_id:,
+                  # When the source was first stored.
+                  created_at: nil,
+                  # When the source was last written; re-ingesting moves it.
+                  updated_at: nil
+                )
+                end
+
+                sig do
+                  override.returns(
+                    {
+                      id: String,
+                      content:
+                        Telnyx::Models::AI::Memory::Namespaces::Profiles::SourceRetrieveResponse::Data::Content::Variants,
+                      memory_count: Integer,
+                      session_id: T.nilable(String),
+                      created_at: T.nilable(String),
+                      updated_at: T.nilable(String)
+                    }
+                  )
+                end
+                def to_hash
+                end
+
+                # What was stored, in the shape it was sent: an ingested JSON body as JSON, a
+                # string body or a remembered fact as a string. A session ingested before formats
+                # were recorded is returned as the text it was stored as.
+                module Content
+                  extend Telnyx::Internal::Type::Union
+
+                  Variants =
+                    T.type_alias do
+                      T.any(
+                        T::Hash[Symbol, T.anything],
+                        Telnyx::Models::AI::Memory::Namespaces::Profiles::SourceRetrieveResponse::Data::Content::UnionMember1::Variants
+                      )
+                    end
+
+                  module UnionMember1
+                    extend Telnyx::Internal::Type::Union
+
+                    Variants =
+                      T.type_alias do
+                        T.any(T::Array[T.anything], String, Float, T::Boolean)
+                      end
+
+                    sig do
+                      override.returns(
+                        T::Array[
+                          Telnyx::Models::AI::Memory::Namespaces::Profiles::SourceRetrieveResponse::Data::Content::UnionMember1::Variants
+                        ]
+                      )
+                    end
+                    def self.variants
+                    end
+
+                    UnionMember0Array =
+                      T.let(
+                        Telnyx::Internal::Type::ArrayOf[
+                          Telnyx::Internal::Type::Unknown
+                        ],
+                        Telnyx::Internal::Type::Converter
+                      )
+                  end
+
+                  sig do
+                    override.returns(
+                      T::Array[
+                        Telnyx::Models::AI::Memory::Namespaces::Profiles::SourceRetrieveResponse::Data::Content::Variants
+                      ]
+                    )
+                  end
+                  def self.variants
+                  end
+
+                  UnionMember0Map =
+                    T.let(
+                      Telnyx::Internal::Type::HashOf[
+                        Telnyx::Internal::Type::Unknown
+                      ],
+                      Telnyx::Internal::Type::Converter
+                    )
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end