telnyx 5.169.0 → 5.171.0

data/lib/telnyx/models/ai/memory/namespace_retrieve_params.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      module Memory
+        # @see Telnyx::Resources::AI::Memory::Namespaces#retrieve
+        class NamespaceRetrieveParams < Telnyx::Internal::Type::BaseModel
+          extend Telnyx::Internal::Type::RequestParameters::Converter
+          include Telnyx::Internal::Type::RequestParameters
+
+          # @!attribute namespace
+          #
+          #   @return [String]
+          required :namespace, String
+
+          # @!attribute operation_id
+          #
+          #   @return [String]
+          required :operation_id, String
+
+          # @!method initialize(namespace:, operation_id:, request_options: {})
+          #   @param namespace [String]
+          #   @param operation_id [String]
+          #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/ai/memory/namespace_retrieve_response.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      module Memory
+        # @see Telnyx::Resources::AI::Memory::Namespaces#retrieve
+        class NamespaceRetrieveResponse < Telnyx::Internal::Type::BaseModel
+          # @!attribute data
+          #
+          #   @return [Telnyx::Models::AI::Memory::NamespaceRetrieveResponse::Data]
+          required :data, -> { Telnyx::Models::AI::Memory::NamespaceRetrieveResponse::Data }
+
+          # @!method initialize(data:)
+          #   @param data [Telnyx::Models::AI::Memory::NamespaceRetrieveResponse::Data]
+
+          # @see Telnyx::Models::AI::Memory::NamespaceRetrieveResponse#data
+          class Data < Telnyx::Internal::Type::BaseModel
+            # @!attribute operation_id
+            #
+            #   @return [String]
+            required :operation_id, String
+
+            # @!attribute status
+            #   Where the write is. `completed`, `failed` and `cancelled` are terminal: stop
+            #   polling at any of them, and treat `failed` and `cancelled` as writes that did
+            #   not happen.
+            #
+            #   @return [Symbol, Telnyx::Models::AI::Memory::NamespaceRetrieveResponse::Data::Status]
+            required :status, enum: -> { Telnyx::Models::AI::Memory::NamespaceRetrieveResponse::Data::Status }
+
+            # @!attribute completed_at
+            #
+            #   @return [String, nil]
+            optional :completed_at, String, nil?: true
+
+            # @!attribute created_at
+            #
+            #   @return [String, nil]
+            optional :created_at, String, nil?: true
+
+            # @!method initialize(operation_id:, status:, completed_at: nil, created_at: nil)
+            #   Some parameter documentations has been truncated, see
+            #   {Telnyx::Models::AI::Memory::NamespaceRetrieveResponse::Data} for more details.
+            #
+            #   @param operation_id [String]
+            #
+            #   @param status [Symbol, Telnyx::Models::AI::Memory::NamespaceRetrieveResponse::Data::Status] Where the write is. `completed`, `failed` and `cancelled` are terminal: stop pol
+            #
+            #   @param completed_at [String, nil]
+            #
+            #   @param created_at [String, nil]
+
+            # Where the write is. `completed`, `failed` and `cancelled` are terminal: stop
+            # polling at any of them, and treat `failed` and `cancelled` as writes that did
+            # not happen.
+            #
+            # @see Telnyx::Models::AI::Memory::NamespaceRetrieveResponse::Data#status
+            module Status
+              extend Telnyx::Internal::Type::Enum
+
+              PENDING = :pending
+              PROCESSING = :processing
+              COMPLETED = :completed
+              FAILED = :failed
+              CANCELLED = :cancelled
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/ai/memory/namespaces/namespace_settings_response.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      module Memory
+        module Namespaces
+          # @see Telnyx::Resources::AI::Memory::Namespaces::Settings#list
+          class NamespaceSettingsResponse < Telnyx::Internal::Type::BaseModel
+            # @!attribute data
+            #   A namespace's settings, grouped by what they affect.
+            #
+            #   @return [Telnyx::Models::AI::Memory::Namespaces::NamespaceSettingsResponse::Data]
+            required :data, -> { Telnyx::AI::Memory::Namespaces::NamespaceSettingsResponse::Data }
+
+            # @!method initialize(data:)
+            #   @param data [Telnyx::Models::AI::Memory::Namespaces::NamespaceSettingsResponse::Data] A namespace's settings, grouped by what they affect.
+
+            # @see Telnyx::Models::AI::Memory::Namespaces::NamespaceSettingsResponse#data
+            class Data < Telnyx::Internal::Type::BaseModel
+              # @!attribute summary
+              #   Settings that shape this namespace's summaries.
+              #
+              #   @return [Telnyx::Models::AI::Memory::Namespaces::NamespaceSettingsResponse::Data::Summary, nil]
+              optional :summary, -> { Telnyx::AI::Memory::Namespaces::NamespaceSettingsResponse::Data::Summary }
+
+              # @!method initialize(summary: nil)
+              #   A namespace's settings, grouped by what they affect.
+              #
+              #   @param summary [Telnyx::Models::AI::Memory::Namespaces::NamespaceSettingsResponse::Data::Summary] Settings that shape this namespace's summaries.
+
+              # @see Telnyx::Models::AI::Memory::Namespaces::NamespaceSettingsResponse::Data#summary
+              class Summary < Telnyx::Internal::Type::BaseModel
+                # @!attribute instructions
+                #   Free-form instructions that influence how this namespace's summaries are
+                #   written, shared by every profile in the namespace. How you use them is up to you
+                #   -- they steer the outcome, so try a phrasing and see how the summary comes out.
+                #   Advisory: they steer the summary but never override or deny a profile's own
+                #   facts, and they do not affect recall. Null or empty means none are set, and
+                #   summaries use the neutral default. A change reaches each summary the next time
+                #   it is regenerated.
+                #
+                #   @return [String, nil]
+                optional :instructions, String, nil?: true
+
+                # @!method initialize(instructions: nil)
+                #   Some parameter documentations has been truncated, see
+                #   {Telnyx::Models::AI::Memory::Namespaces::NamespaceSettingsResponse::Data::Summary}
+                #   for more details.
+                #
+                #   Settings that shape this namespace's summaries.
+                #
+                #   @param instructions [String, nil] Free-form instructions that influence how this namespace's summaries are written
+              end
+            end
+          end
+        end
+
+        NamespaceSettingsResponse = Namespaces::NamespaceSettingsResponse
+      end
+    end
+  end
+end

data/lib/telnyx/models/ai/memory/namespaces/page_meta.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      module Memory
+        module Namespaces
+          class PageMeta < Telnyx::Internal::Type::BaseModel
+            # @!attribute page_number
+            #   The page returned, counting from 1.
+            #
+            #   @return [Integer]
+            required :page_number, Integer
+
+            # @!attribute page_size
+            #   How many results a page holds.
+            #
+            #   @return [Integer]
+            required :page_size, Integer
+
+            # @!attribute total_pages
+            #   Pages that can be requested; 0 when nothing matched. Page until `page_number`
+            #   reaches it rather than until a page comes back short: a page can hold fewer than
+            #   `page_size` results without being the last. Capped at the deepest page served,
+            #   so on a very large listing it covers fewer results than `total_results`.
+            #
+            #   @return [Integer]
+            required :total_pages, Integer
+
+            # @!attribute total_results
+            #   Results the request matched, including any past the deepest page.
+            #
+            #   @return [Integer]
+            required :total_results, Integer
+
+            # @!method initialize(page_number:, page_size:, total_pages:, total_results:)
+            #   Some parameter documentations has been truncated, see
+            #   {Telnyx::Models::AI::Memory::Namespaces::PageMeta} for more details.
+            #
+            #   Where a listing's page sits in the whole.
+            #
+            #   A page is a snapshot: the counts it reports and the order it is drawn in both
+            #   move as writes land, so paging through a busy namespace can repeat or miss an
+            #   entry at a page boundary.
+            #
+            #   @param page_number [Integer] The page returned, counting from 1.
+            #
+            #   @param page_size [Integer] How many results a page holds.
+            #
+            #   @param total_pages [Integer] Pages that can be requested; 0 when nothing matched. Page until `page_number` re
+            #
+            #   @param total_results [Integer] Results the request matched, including any past the deepest page.
+          end
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/ai/memory/namespaces/profile_delete_params.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      module Memory
+        module Namespaces
+          # @see Telnyx::Resources::AI::Memory::Namespaces::Profiles#delete
+          class ProfileDeleteParams < Telnyx::Internal::Type::BaseModel
+            extend Telnyx::Internal::Type::RequestParameters::Converter
+            include Telnyx::Internal::Type::RequestParameters
+
+            # @!attribute namespace
+            #   The namespace. `default` exists for every organization.
+            #
+            #   @return [String]
+            required :namespace, String
+
+            # @!attribute profile_id
+            #
+            #   @return [String]
+            required :profile_id, String
+
+            # @!method initialize(namespace:, profile_id:, request_options: {})
+            #   @param namespace [String] The namespace. `default` exists for every organization.
+            #
+            #   @param profile_id [String]
+            #
+            #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/ai/memory/namespaces/profile_delete_response.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      module Memory
+        module Namespaces
+          # @see Telnyx::Resources::AI::Memory::Namespaces::Profiles#delete
+          class ProfileDeleteResponse < Telnyx::Internal::Type::BaseModel
+            # @!attribute data
+            #
+            #   @return [Telnyx::Models::AI::Memory::Namespaces::ProfileDeleteResponse::Data]
+            required :data, -> { Telnyx::Models::AI::Memory::Namespaces::ProfileDeleteResponse::Data }
+
+            # @!method initialize(data:)
+            #   @param data [Telnyx::Models::AI::Memory::Namespaces::ProfileDeleteResponse::Data]
+
+            # @see Telnyx::Models::AI::Memory::Namespaces::ProfileDeleteResponse#data
+            class Data < Telnyx::Internal::Type::BaseModel
+              # @!attribute memories_deleted
+              #   Memories the profile held and no longer does, counted before and after. A report
+              #   rather than an audit: memory moves in the background between the two counts. The
+              #   status carries the outcome.
+              #
+              #   @return [Integer]
+              required :memories_deleted, Integer
+
+              # @!attribute profile_id
+              #
+              #   @return [String]
+              required :profile_id, String
+
+              # @!method initialize(memories_deleted:, profile_id:)
+              #   Some parameter documentations has been truncated, see
+              #   {Telnyx::Models::AI::Memory::Namespaces::ProfileDeleteResponse::Data} for more
+              #   details.
+              #
+              #   @param memories_deleted [Integer] Memories the profile held and no longer does, counted before and after. A report
+              #
+              #   @param profile_id [String]
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/ai/memory/namespaces/profile_ingest_params.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      module Memory
+        module Namespaces
+          # @see Telnyx::Resources::AI::Memory::Namespaces::Profiles#ingest
+          class ProfileIngestParams < Telnyx::Internal::Type::BaseModel
+            extend Telnyx::Internal::Type::RequestParameters::Converter
+            include Telnyx::Internal::Type::RequestParameters
+
+            # @!attribute namespace
+            #
+            #   @return [String]
+            required :namespace, String
+
+            # @!attribute profile_id
+            #
+            #   @return [String]
+            required :profile_id, String
+
+            # @!attribute body
+            #   The session's messages, in whatever shape your framework produces. Any JSON
+            #   value but null is accepted and stored whole, as long as it holds something to
+            #   remember: a body with no content anywhere in it -- `{}`, `[]`, `""`,
+            #   `{"messages": []}` -- is a 422.
+            #
+            #   @return [Hash{Symbol=>Object}, Array<Object>, String, Float, Boolean]
+            required :body, union: -> { Telnyx::AI::Memory::Namespaces::ProfileIngestParams::Body }
+
+            # @!attribute session_id
+            #   Names the session. Re-ingesting the same session replaces what it held and keeps
+            #   its `source_id`. Omit it to have one derived from the content and returned. No
+            #   whitespace, control characters, or any of / \ # ? %.
+            #
+            #   @return [String, nil]
+            optional :session_id, String, nil?: true
+
+            # @!method initialize(namespace:, profile_id:, body:, session_id: nil, request_options: {})
+            #   Some parameter documentations has been truncated, see
+            #   {Telnyx::Models::AI::Memory::Namespaces::ProfileIngestParams} for more details.
+            #
+            #   @param namespace [String]
+            #
+            #   @param profile_id [String]
+            #
+            #   @param body [Hash{Symbol=>Object}, Array<Object>, String, Float, Boolean] The session's messages, in whatever shape your framework produces. Any JSON valu
+            #
+            #   @param session_id [String, nil] Names the session. Re-ingesting the same session replaces what it held and keeps
+            #
+            #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+
+            # The session's messages, in whatever shape your framework produces. Any JSON
+            # value but null is accepted and stored whole, as long as it holds something to
+            # remember: a body with no content anywhere in it -- `{}`, `[]`, `""`,
+            # `{"messages": []}` -- is a 422.
+            module Body
+              extend Telnyx::Internal::Type::Union
+
+              variant -> { Telnyx::Models::AI::Memory::Namespaces::ProfileIngestParams::Body::UnionMember0Map }
+
+              variant union: -> { Telnyx::AI::Memory::Namespaces::ProfileIngestParams::Body::UnionMember1 }
+
+              module UnionMember1
+                extend Telnyx::Internal::Type::Union
+
+                variant -> { Telnyx::Models::AI::Memory::Namespaces::ProfileIngestParams::Body::UnionMember1::UnionMember0Array }
+
+                variant String
+
+                variant Float
+
+                variant Telnyx::Internal::Type::Boolean
+
+                # @!method self.variants
+                #   @return [Array(Array<Object>, String, Float, Boolean)]
+
+                # @type [Telnyx::Internal::Type::Converter]
+                UnionMember0Array = Telnyx::Internal::Type::ArrayOf[Telnyx::Internal::Type::Unknown]
+              end
+
+              # @!method self.variants
+              #   @return [Array(Hash{Symbol=>Object}, Array<Object>, String, Float, Boolean)]
+
+              # @type [Telnyx::Internal::Type::Converter]
+              UnionMember0Map = Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/ai/memory/namespaces/profile_ingest_response.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      module Memory
+        module Namespaces
+          # @see Telnyx::Resources::AI::Memory::Namespaces::Profiles#ingest
+          class ProfileIngestResponse < Telnyx::Internal::Type::BaseModel
+            # @!attribute data
+            #
+            #   @return [Telnyx::Models::AI::Memory::Namespaces::ProfileIngestResponse::Data]
+            required :data, -> { Telnyx::Models::AI::Memory::Namespaces::ProfileIngestResponse::Data }
+
+            # @!method initialize(data:)
+            #   @param data [Telnyx::Models::AI::Memory::Namespaces::ProfileIngestResponse::Data]
+
+            # @see Telnyx::Models::AI::Memory::Namespaces::ProfileIngestResponse#data
+            class Data < Telnyx::Internal::Type::BaseModel
+              # @!attribute operation_id
+              #
+              #   @return [String]
+              required :operation_id, String
+
+              # @!attribute profile_id
+              #
+              #   @return [String]
+              required :profile_id, String
+
+              # @!attribute session_id
+              #
+              #   @return [String]
+              required :session_id, String
+
+              # @!attribute source_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.
+              #
+              #   @return [String]
+              required :source_id, String
+
+              # @!method initialize(operation_id:, profile_id:, session_id:, source_id:)
+              #   Some parameter documentations has been truncated, see
+              #   {Telnyx::Models::AI::Memory::Namespaces::ProfileIngestResponse::Data} for more
+              #   details.
+              #
+              #   @param operation_id [String]
+              #
+              #   @param profile_id [String]
+              #
+              #   @param session_id [String]
+              #
+              #   @param source_id [String] Identifies one source within its profile: an ingested session, or one remembered
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/ai/memory/namespaces/profile_list_params.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      module Memory
+        module Namespaces
+          # @see Telnyx::Resources::AI::Memory::Namespaces::Profiles#list
+          class ProfileListParams < Telnyx::Internal::Type::BaseModel
+            extend Telnyx::Internal::Type::RequestParameters::Converter
+            include Telnyx::Internal::Type::RequestParameters
+
+            # @!attribute namespace
+            #
+            #   @return [String]
+            required :namespace, String
+
+            # @!attribute page_number
+            #   The page to return, counting from 1. Bounded in depth: (page[number] - 1) \*
+            #   page[size] may be at most 10000.
+            #
+            #   @return [Integer, nil]
+            optional :page_number, Integer
+
+            # @!attribute page_size
+            #   How many results a page holds.
+            #
+            #   @return [Integer, nil]
+            optional :page_size, Integer
+
+            # @!method initialize(namespace:, page_number: nil, page_size: nil, request_options: {})
+            #   Some parameter documentations has been truncated, see
+            #   {Telnyx::Models::AI::Memory::Namespaces::ProfileListParams} for more details.
+            #
+            #   @param namespace [String]
+            #
+            #   @param page_number [Integer] The page to return, counting from 1. Bounded in depth: (page[number] - 1) \*
+            #   page
+            #
+            #   @param page_size [Integer] How many results a page holds.
+            #
+            #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/ai/memory/namespaces/profile_list_response.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      module Memory
+        module Namespaces
+          # @see Telnyx::Resources::AI::Memory::Namespaces::Profiles#list
+          class ProfileListResponse < Telnyx::Internal::Type::BaseModel
+            # @!attribute memory_count
+            #   Memories stored under this profile, including the consolidated ones that
+            #   paraphrase others. Listings are ordered by it.
+            #
+            #   @return [Integer]
+            required :memory_count, Integer
+
+            # @!attribute profile_id
+            #
+            #   @return [String]
+            required :profile_id, String
+
+            # @!method initialize(memory_count:, profile_id:)
+            #   Some parameter documentations has been truncated, see
+            #   {Telnyx::Models::AI::Memory::Namespaces::ProfileListResponse} for more details.
+            #
+            #   @param memory_count [Integer] Memories stored under this profile, including the consolidated ones that paraphr
+            #
+            #   @param profile_id [String]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/ai/memory/namespaces/profile_preview_params.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      module Memory
+        module Namespaces
+          # @see Telnyx::Resources::AI::Memory::Namespaces::Profiles#preview
+          class ProfilePreviewParams < Telnyx::Internal::Type::BaseModel
+            extend Telnyx::Internal::Type::RequestParameters::Converter
+            include Telnyx::Internal::Type::RequestParameters
+
+            # @!attribute namespace
+            #   The namespace. `default` exists for every organization.
+            #
+            #   @return [String]
+            required :namespace, String
+
+            # @!attribute profile_id
+            #
+            #   @return [String]
+            required :profile_id, String
+
+            # @!attribute instructions
+            #   The candidate note to try. `null`, empty, or whitespace-only previews the
+            #   neutral default -- the summary a profile returns to when instructions are
+            #   cleared. Capped at 2000 characters, the same cap `PATCH /settings` applies on
+            #   save; a longer note is refused with `422` before anything is generated.
+            #
+            #   @return [String, nil]
+            optional :instructions, String, nil?: true
+
+            # @!method initialize(namespace:, profile_id:, instructions: nil, request_options: {})
+            #   Some parameter documentations has been truncated, see
+            #   {Telnyx::Models::AI::Memory::Namespaces::ProfilePreviewParams} for more details.
+            #
+            #   @param namespace [String] The namespace. `default` exists for every organization.
+            #
+            #   @param profile_id [String]
+            #
+            #   @param instructions [String, nil] The candidate note to try. `null`, empty, or whitespace-only previews the neutra
+            #
+            #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/ai/memory/namespaces/profile_preview_response.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      module Memory
+        module Namespaces
+          # @see Telnyx::Resources::AI::Memory::Namespaces::Profiles#preview
+          class ProfilePreviewResponse < Telnyx::Internal::Type::BaseModel
+            # @!attribute data
+            #
+            #   @return [Telnyx::Models::AI::Memory::Namespaces::ProfilePreviewResponse::Data]
+            required :data, -> { Telnyx::Models::AI::Memory::Namespaces::ProfilePreviewResponse::Data }
+
+            # @!method initialize(data:)
+            #   @param data [Telnyx::Models::AI::Memory::Namespaces::ProfilePreviewResponse::Data]
+
+            # @see Telnyx::Models::AI::Memory::Namespaces::ProfilePreviewResponse#data
+            class Data < Telnyx::Internal::Type::BaseModel
+              # @!attribute profile_id
+              #
+              #   @return [String]
+              required :profile_id, String
+
+              # @!attribute text
+              #   The summary this profile would carry under the candidate note. Null when nothing
+              #   was generated -- the same signal `GET /summary` uses for a profile with no card
+              #   yet.
+              #
+              #   @return [String, nil]
+              required :text, String, nil?: true
+
+              # @!method initialize(profile_id:, text:)
+              #   Some parameter documentations has been truncated, see
+              #   {Telnyx::Models::AI::Memory::Namespaces::ProfilePreviewResponse::Data} for more
+              #   details.
+              #
+              #   @param profile_id [String]
+              #
+              #   @param text [String, nil] The summary this profile would carry under the candidate note. Null when nothing
+            end
+          end
+        end
+      end
+    end
+  end
+end