telnyx 5.166.0 → 5.168.0

data/lib/telnyx/models/compute/func_retrieve_logs_response.rb

@@ -0,0 +1,161 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Compute
+      # @see Telnyx::Resources::Compute::Funcs#retrieve_logs
+      module FuncRetrieveLogsResponse
+        extend Telnyx::Internal::Type::Union
+
+        variant -> { Telnyx::Models::Compute::FuncRetrieveLogsResponse::FuncRuntimeLogsResponse }
+
+        variant -> { Telnyx::Models::Compute::FuncRetrieveLogsResponse::FuncInvocationLogsResponse }
+
+        class FuncRuntimeLogsResponse < Telnyx::Internal::Type::BaseModel
+          # @!attribute data
+          #
+          #   @return [Array<Telnyx::Models::Compute::FuncRetrieveLogsResponse::FuncRuntimeLogsResponse::Data>, nil]
+          optional :data,
+                   -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Models::Compute::FuncRetrieveLogsResponse::FuncRuntimeLogsResponse::Data] }
+
+          # @!attribute meta
+          #
+          #   @return [Telnyx::Models::Compute::LogsMeta, nil]
+          optional :meta, -> { Telnyx::Compute::LogsMeta }
+
+          # @!method initialize(data: nil, meta: nil)
+          #   @param data [Array<Telnyx::Models::Compute::FuncRetrieveLogsResponse::FuncRuntimeLogsResponse::Data>]
+          #   @param meta [Telnyx::Models::Compute::LogsMeta]
+
+          class Data < Telnyx::Internal::Type::BaseModel
+            # @!attribute level
+            #
+            #   @return [String, nil]
+            optional :level, String
+
+            # @!attribute message
+            #
+            #   @return [String, nil]
+            optional :message, String
+
+            # @!attribute record_type
+            #
+            #   @return [Symbol, Telnyx::Models::Compute::FuncRetrieveLogsResponse::FuncRuntimeLogsResponse::Data::RecordType, nil]
+            optional :record_type,
+                     enum: -> { Telnyx::Models::Compute::FuncRetrieveLogsResponse::FuncRuntimeLogsResponse::Data::RecordType }
+
+            # @!attribute timestamp
+            #
+            #   @return [Time, nil]
+            optional :timestamp, Time
+
+            # @!method initialize(level: nil, message: nil, record_type: nil, timestamp: nil)
+            #   @param level [String]
+            #   @param message [String]
+            #   @param record_type [Symbol, Telnyx::Models::Compute::FuncRetrieveLogsResponse::FuncRuntimeLogsResponse::Data::RecordType]
+            #   @param timestamp [Time]
+
+            # @see Telnyx::Models::Compute::FuncRetrieveLogsResponse::FuncRuntimeLogsResponse::Data#record_type
+            module RecordType
+              extend Telnyx::Internal::Type::Enum
+
+              COMPUTE_FUNC_RUNTIME_LOG = :compute_func_runtime_log
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+        end
+
+        class FuncInvocationLogsResponse < Telnyx::Internal::Type::BaseModel
+          # @!attribute data
+          #
+          #   @return [Array<Telnyx::Models::Compute::FuncRetrieveLogsResponse::FuncInvocationLogsResponse::Data>, nil]
+          optional :data,
+                   -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Models::Compute::FuncRetrieveLogsResponse::FuncInvocationLogsResponse::Data] }
+
+          # @!attribute meta
+          #
+          #   @return [Telnyx::Models::Compute::LogsMeta, nil]
+          optional :meta, -> { Telnyx::Compute::LogsMeta }
+
+          # @!method initialize(data: nil, meta: nil)
+          #   @param data [Array<Telnyx::Models::Compute::FuncRetrieveLogsResponse::FuncInvocationLogsResponse::Data>]
+          #   @param meta [Telnyx::Models::Compute::LogsMeta]
+
+          class Data < Telnyx::Internal::Type::BaseModel
+            # @!attribute duration_ms
+            #
+            #   @return [Float, nil]
+            optional :duration_ms, Float
+
+            # @!attribute method_
+            #
+            #   @return [String, nil]
+            optional :method_, String, api_name: :method
+
+            # @!attribute path
+            #
+            #   @return [String, nil]
+            optional :path, String
+
+            # @!attribute record_type
+            #
+            #   @return [Symbol, Telnyx::Models::Compute::FuncRetrieveLogsResponse::FuncInvocationLogsResponse::Data::RecordType, nil]
+            optional :record_type,
+                     enum: -> { Telnyx::Models::Compute::FuncRetrieveLogsResponse::FuncInvocationLogsResponse::Data::RecordType }
+
+            # @!attribute region
+            #
+            #   @return [String, nil]
+            optional :region, String
+
+            # @!attribute request_size_bytes
+            #
+            #   @return [Integer, nil]
+            optional :request_size_bytes, Integer
+
+            # @!attribute response_size_bytes
+            #
+            #   @return [Integer, nil]
+            optional :response_size_bytes, Integer
+
+            # @!attribute status_code
+            #
+            #   @return [Integer, nil]
+            optional :status_code, Integer
+
+            # @!attribute timestamp
+            #
+            #   @return [Time, nil]
+            optional :timestamp, Time
+
+            # @!method initialize(duration_ms: nil, method_: nil, path: nil, record_type: nil, region: nil, request_size_bytes: nil, response_size_bytes: nil, status_code: nil, timestamp: nil)
+            #   @param duration_ms [Float]
+            #   @param method_ [String]
+            #   @param path [String]
+            #   @param record_type [Symbol, Telnyx::Models::Compute::FuncRetrieveLogsResponse::FuncInvocationLogsResponse::Data::RecordType]
+            #   @param region [String]
+            #   @param request_size_bytes [Integer]
+            #   @param response_size_bytes [Integer]
+            #   @param status_code [Integer]
+            #   @param timestamp [Time]
+
+            # @see Telnyx::Models::Compute::FuncRetrieveLogsResponse::FuncInvocationLogsResponse::Data#record_type
+            module RecordType
+              extend Telnyx::Internal::Type::Enum
+
+              COMPUTE_FUNC_INVOCATION_LOG = :compute_func_invocation_log
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+        end
+
+        # @!method self.variants
+        #   @return [Array(Telnyx::Models::Compute::FuncRetrieveLogsResponse::FuncRuntimeLogsResponse, Telnyx::Models::Compute::FuncRetrieveLogsResponse::FuncInvocationLogsResponse)]
+      end
+    end
+  end
+end

data/lib/telnyx/models/compute/func_retrieve_metric_aggregates_params.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Compute
+      # @see Telnyx::Resources::Compute::Funcs#retrieve_metric_aggregates
+      class FuncRetrieveMetricAggregatesParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute end_time
+        #   Exclusive window end, UTC ISO 8601 with milliseconds
+        #
+        #   @return [Time]
+        required :end_time, Time
+
+        # @!attribute start_time
+        #   Inclusive window start, UTC ISO 8601 with milliseconds
+        #
+        #   @return [Time]
+        required :start_time, Time
+
+        # @!attribute filter_edge_site
+        #   Edge site filter
+        #
+        #   @return [String, nil]
+        optional :filter_edge_site, String
+
+        # @!attribute filter_namespace
+        #   Kubernetes namespace filter
+        #
+        #   @return [String, nil]
+        optional :filter_namespace, String
+
+        # @!attribute page_number
+        #
+        #   @return [Integer, nil]
+        optional :page_number, Integer
+
+        # @!attribute page_size
+        #
+        #   @return [Integer, nil]
+        optional :page_size, Integer
+
+        # @!method initialize(id:, end_time:, start_time:, filter_edge_site: nil, filter_namespace: nil, page_number: nil, page_size: nil, request_options: {})
+        #   @param id [String]
+        #
+        #   @param end_time [Time] Exclusive window end, UTC ISO 8601 with milliseconds
+        #
+        #   @param start_time [Time] Inclusive window start, UTC ISO 8601 with milliseconds
+        #
+        #   @param filter_edge_site [String] Edge site filter
+        #
+        #   @param filter_namespace [String] Kubernetes namespace filter
+        #
+        #   @param page_number [Integer]
+        #
+        #   @param page_size [Integer]
+        #
+        #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/telnyx/models/compute/func_retrieve_metric_aggregates_response.rb

@@ -0,0 +1,137 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Compute
+      # @see Telnyx::Resources::Compute::Funcs#retrieve_metric_aggregates
+      class FuncRetrieveMetricAggregatesResponse < Telnyx::Internal::Type::BaseModel
+        # @!attribute data
+        #
+        #   @return [Array<Telnyx::Models::Compute::FuncRetrieveMetricAggregatesResponse::Data>, nil]
+        optional :data,
+                 -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Models::Compute::FuncRetrieveMetricAggregatesResponse::Data] }
+
+        # @!attribute meta
+        #
+        #   @return [Telnyx::Models::Compute::FunctionsObservabilityPaginationMeta, nil]
+        optional :meta, -> { Telnyx::Compute::FunctionsObservabilityPaginationMeta }
+
+        # @!method initialize(data: nil, meta: nil)
+        #   @param data [Array<Telnyx::Models::Compute::FuncRetrieveMetricAggregatesResponse::Data>]
+        #   @param meta [Telnyx::Models::Compute::FunctionsObservabilityPaginationMeta]
+
+        class Data < Telnyx::Internal::Type::BaseModel
+          # @!attribute cpu_used_cores_avg
+          #
+          #   @return [Float, nil]
+          optional :cpu_used_cores_avg, Float, nil?: true
+
+          # @!attribute cpu_used_cores_max
+          #
+          #   @return [Float, nil]
+          optional :cpu_used_cores_max, Float, nil?: true
+
+          # @!attribute end_time
+          #
+          #   @return [Time, nil]
+          optional :end_time, Time
+
+          # @!attribute function_id
+          #
+          #   @return [String, nil]
+          optional :function_id, String
+
+          # @!attribute function_name
+          #
+          #   @return [String, nil]
+          optional :function_name, String
+
+          # @!attribute memory_used_bytes_avg
+          #
+          #   @return [Float, nil]
+          optional :memory_used_bytes_avg, Float, nil?: true
+
+          # @!attribute memory_used_bytes_max
+          #
+          #   @return [Float, nil]
+          optional :memory_used_bytes_max, Float, nil?: true
+
+          # @!attribute product
+          #
+          #   @return [String, nil]
+          optional :product, String
+
+          # @!attribute record_type
+          #
+          #   @return [String, nil]
+          optional :record_type, String
+
+          # @!attribute request_client_error_rate
+          #
+          #   @return [Float, nil]
+          optional :request_client_error_rate, Float, nil?: true
+
+          # @!attribute request_count
+          #
+          #   @return [Float, nil]
+          optional :request_count, Float, nil?: true
+
+          # @!attribute request_error_rate
+          #
+          #   @return [Float, nil]
+          optional :request_error_rate, Float, nil?: true
+
+          # @!attribute request_latency_avg_ms
+          #
+          #   @return [Float, nil]
+          optional :request_latency_avg_ms, Float, nil?: true
+
+          # @!attribute request_latency_p50_ms
+          #
+          #   @return [Float, nil]
+          optional :request_latency_p50_ms, Float, nil?: true
+
+          # @!attribute request_latency_p95_ms
+          #
+          #   @return [Float, nil]
+          optional :request_latency_p95_ms, Float, nil?: true
+
+          # @!attribute request_latency_p99_ms
+          #
+          #   @return [Float, nil]
+          optional :request_latency_p99_ms, Float, nil?: true
+
+          # @!attribute request_success_rate
+          #
+          #   @return [Float, nil]
+          optional :request_success_rate, Float, nil?: true
+
+          # @!attribute start_time
+          #
+          #   @return [Time, nil]
+          optional :start_time, Time
+
+          # @!method initialize(cpu_used_cores_avg: nil, cpu_used_cores_max: nil, end_time: nil, function_id: nil, function_name: nil, memory_used_bytes_avg: nil, memory_used_bytes_max: nil, product: nil, record_type: nil, request_client_error_rate: nil, request_count: nil, request_error_rate: nil, request_latency_avg_ms: nil, request_latency_p50_ms: nil, request_latency_p95_ms: nil, request_latency_p99_ms: nil, request_success_rate: nil, start_time: nil)
+          #   @param cpu_used_cores_avg [Float, nil]
+          #   @param cpu_used_cores_max [Float, nil]
+          #   @param end_time [Time]
+          #   @param function_id [String]
+          #   @param function_name [String]
+          #   @param memory_used_bytes_avg [Float, nil]
+          #   @param memory_used_bytes_max [Float, nil]
+          #   @param product [String]
+          #   @param record_type [String]
+          #   @param request_client_error_rate [Float, nil]
+          #   @param request_count [Float, nil]
+          #   @param request_error_rate [Float, nil]
+          #   @param request_latency_avg_ms [Float, nil]
+          #   @param request_latency_p50_ms [Float, nil]
+          #   @param request_latency_p95_ms [Float, nil]
+          #   @param request_latency_p99_ms [Float, nil]
+          #   @param request_success_rate [Float, nil]
+          #   @param start_time [Time]
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/compute/func_retrieve_revisions_params.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Compute
+      # @see Telnyx::Resources::Compute::Funcs#retrieve_revisions
+      class FuncRetrieveRevisionsParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute page_number
+        #
+        #   @return [Integer, nil]
+        optional :page_number, Integer
+
+        # @!attribute page_size
+        #
+        #   @return [Integer, nil]
+        optional :page_size, Integer
+
+        # @!method initialize(id:, page_number: nil, page_size: nil, request_options: {})
+        #   @param id [String]
+        #   @param page_number [Integer]
+        #   @param page_size [Integer]
+        #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/telnyx/models/compute/func_retrieve_revisions_response.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Compute
+      # @see Telnyx::Resources::Compute::Funcs#retrieve_revisions
+      class FuncRetrieveRevisionsResponse < Telnyx::Internal::Type::BaseModel
+        # @!attribute data
+        #
+        #   @return [Array<Telnyx::Models::Compute::FuncRetrieveRevisionsResponse::Data>, nil]
+        optional :data,
+                 -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Models::Compute::FuncRetrieveRevisionsResponse::Data] }
+
+        # @!attribute meta
+        #
+        #   @return [Telnyx::Models::Compute::FunctionsObservabilityPaginationMeta, nil]
+        optional :meta, -> { Telnyx::Compute::FunctionsObservabilityPaginationMeta }
+
+        # @!method initialize(data: nil, meta: nil)
+        #   @param data [Array<Telnyx::Models::Compute::FuncRetrieveRevisionsResponse::Data>]
+        #   @param meta [Telnyx::Models::Compute::FunctionsObservabilityPaginationMeta]
+
+        class Data < Telnyx::Internal::Type::BaseModel
+          # @!attribute active
+          #
+          #   @return [Boolean, nil]
+          optional :active, Telnyx::Internal::Type::Boolean
+
+          # @!attribute build_ok_at
+          #
+          #   @return [Time, nil]
+          optional :build_ok_at, Time
+
+          # @!attribute build_status
+          #
+          #   @return [String, nil]
+          optional :build_status, String
+
+          # @!attribute commit_sha
+          #
+          #   @return [String, nil]
+          optional :commit_sha, String
+
+          # @!attribute deploy_status
+          #
+          #   @return [String, nil]
+          optional :deploy_status, String
+
+          # @!attribute failure_reason
+          #
+          #   @return [String, nil]
+          optional :failure_reason, String
+
+          # @!attribute failure_stage
+          #
+          #   @return [String, nil]
+          optional :failure_stage, String
+
+          # @!attribute image
+          #
+          #   @return [String, nil]
+          optional :image, String
+
+          # @!attribute record_type
+          #
+          #   @return [String, nil]
+          optional :record_type, String
+
+          # @!attribute revision_id
+          #
+          #   @return [String, nil]
+          optional :revision_id, String
+
+          # @!attribute shipped_at
+          #
+          #   @return [Time, nil]
+          optional :shipped_at, Time
+
+          # @!attribute shipped_by
+          #
+          #   @return [String, nil]
+          optional :shipped_by, String
+
+          # @!method initialize(active: nil, build_ok_at: nil, build_status: nil, commit_sha: nil, deploy_status: nil, failure_reason: nil, failure_stage: nil, image: nil, record_type: nil, revision_id: nil, shipped_at: nil, shipped_by: nil)
+          #   @param active [Boolean]
+          #   @param build_ok_at [Time]
+          #   @param build_status [String]
+          #   @param commit_sha [String]
+          #   @param deploy_status [String]
+          #   @param failure_reason [String]
+          #   @param failure_stage [String]
+          #   @param image [String]
+          #   @param record_type [String]
+          #   @param revision_id [String]
+          #   @param shipped_at [Time]
+          #   @param shipped_by [String]
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/compute/func_retrieve_ship_inspection_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Compute
+      # @see Telnyx::Resources::Compute::Funcs#retrieve_ship_inspection
+      class FuncRetrieveShipInspectionParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!method initialize(id:, request_options: {})
+        #   @param id [String]
+        #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/telnyx/models/compute/func_retrieve_ship_inspection_response.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Compute
+      # @see Telnyx::Resources::Compute::Funcs#retrieve_ship_inspection
+      class FuncRetrieveShipInspectionResponse < Telnyx::Internal::Type::BaseModel
+        # @!attribute data
+        #
+        #   @return [Telnyx::Models::Compute::FuncRetrieveShipInspectionResponse::Data, nil]
+        optional :data, -> { Telnyx::Models::Compute::FuncRetrieveShipInspectionResponse::Data }
+
+        # @!method initialize(data: nil)
+        #   @param data [Telnyx::Models::Compute::FuncRetrieveShipInspectionResponse::Data]
+
+        # @see Telnyx::Models::Compute::FuncRetrieveShipInspectionResponse#data
+        class Data < Telnyx::Internal::Type::BaseModel
+          # @!attribute created_at
+          #
+          #   @return [Time, nil]
+          optional :created_at, Time
+
+          # @!attribute reason
+          #
+          #   @return [String, nil]
+          optional :reason, String
+
+          # @!attribute record_type
+          #   Stable record type retained by both inspection path aliases.
+          #
+          #   @return [Symbol, Telnyx::Models::Compute::FuncRetrieveShipInspectionResponse::Data::RecordType, nil]
+          optional :record_type,
+                   enum: -> { Telnyx::Models::Compute::FuncRetrieveShipInspectionResponse::Data::RecordType }
+
+          # @!attribute runtime
+          #
+          #   @return [String, nil]
+          optional :runtime, String
+
+          # @!attribute snippet
+          #
+          #   @return [String, nil]
+          optional :snippet, String
+
+          # @!attribute stage
+          #
+          #   @return [Symbol, Telnyx::Models::Compute::FuncRetrieveShipInspectionResponse::Data::Stage, nil]
+          optional :stage, enum: -> { Telnyx::Models::Compute::FuncRetrieveShipInspectionResponse::Data::Stage }
+
+          # @!method initialize(created_at: nil, reason: nil, record_type: nil, runtime: nil, snippet: nil, stage: nil)
+          #   @param created_at [Time]
+          #
+          #   @param reason [String]
+          #
+          #   @param record_type [Symbol, Telnyx::Models::Compute::FuncRetrieveShipInspectionResponse::Data::RecordType] Stable record type retained by both inspection path aliases.
+          #
+          #   @param runtime [String]
+          #
+          #   @param snippet [String]
+          #
+          #   @param stage [Symbol, Telnyx::Models::Compute::FuncRetrieveShipInspectionResponse::Data::Stage]
+
+          # Stable record type retained by both inspection path aliases.
+          #
+          # @see Telnyx::Models::Compute::FuncRetrieveShipInspectionResponse::Data#record_type
+          module RecordType
+            extend Telnyx::Internal::Type::Enum
+
+            BUILD_LOG_INSPECTION = :build_log_inspection
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # @see Telnyx::Models::Compute::FuncRetrieveShipInspectionResponse::Data#stage
+          module Stage
+            extend Telnyx::Internal::Type::Enum
+
+            BUILD = :build
+            PLATFORM = :platform
+            PRE_BUILD = :pre_build
+            DEPLOY = :deploy
+            SECURITY_REVIEW = :security_review
+            NONE = :none
+            PENDING = :pending
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/compute/functions_observability_pagination_meta.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Compute
+      class FunctionsObservabilityPaginationMeta < Telnyx::Internal::Type::BaseModel
+        # @!attribute page_number
+        #
+        #   @return [Integer, nil]
+        optional :page_number, Integer
+
+        # @!attribute page_size
+        #
+        #   @return [Integer, nil]
+        optional :page_size, Integer
+
+        # @!attribute total_pages
+        #
+        #   @return [Integer, nil]
+        optional :total_pages, Integer
+
+        # @!attribute total_results
+        #
+        #   @return [Integer, nil]
+        optional :total_results, Integer
+
+        # @!method initialize(page_number: nil, page_size: nil, total_pages: nil, total_results: nil)
+        #   @param page_number [Integer]
+        #   @param page_size [Integer]
+        #   @param total_pages [Integer]
+        #   @param total_results [Integer]
+      end
+    end
+  end
+end

data/lib/telnyx/models/compute/logs_meta.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Compute
+      class LogsMeta < Telnyx::Internal::Type::BaseModel
+        # @!attribute has_more
+        #
+        #   @return [Boolean, nil]
+        optional :has_more, Telnyx::Internal::Type::Boolean
+
+        # @!attribute partial
+        #
+        #   @return [Boolean, nil]
+        optional :partial, Telnyx::Internal::Type::Boolean
+
+        # @!method initialize(has_more: nil, partial: nil)
+        #   @param has_more [Boolean]
+        #   @param partial [Boolean]
+      end
+    end
+  end
+end

data/lib/telnyx/models/credential_connection.rb

@@ -138,7 +138,10 @@ module Telnyx
 
       # @!attribute password
       #   The password to be used as part of the credentials. Must be 8 to 128 characters
-      #   long.
+      #   long. For primary accounts created on or after September 8, 2026, this password
+      #   is returned as `********`. The password is returned in full on create, and on
+      #   update only when that update changed the password. Accounts created before
+      #   September 8, 2026 are unaffected.
       #
       #   @return [String, nil]
       optional :password, String