telnyx 5.126.0 → 5.128.0

data/rbi/telnyx/models/dir/comment_create_response.rbi

@@ -0,0 +1,362 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Dir
+      class CommentCreateResponse < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::Models::Dir::CommentCreateResponse,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        sig { returns(Telnyx::Models::Dir::CommentCreateResponse::Data) }
+        attr_reader :data
+
+        sig do
+          params(
+            data: Telnyx::Models::Dir::CommentCreateResponse::Data::OrHash
+          ).void
+        end
+        attr_writer :data
+
+        sig do
+          params(
+            data: Telnyx::Models::Dir::CommentCreateResponse::Data::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(data:)
+        end
+
+        sig do
+          override.returns(
+            { data: Telnyx::Models::Dir::CommentCreateResponse::Data }
+          )
+        end
+        def to_hash
+        end
+
+        class Data < Telnyx::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Telnyx::Models::Dir::CommentCreateResponse::Data,
+                Telnyx::Internal::AnyHash
+              )
+            end
+
+          # Comment categorisation. Customers post `customer_inquiry`. The Telnyx team posts
+          # `vetting_comment`, `rejection_reason`, `notification`, `status_update`, or
+          # `admin_response`. `internal_note` is filtered out of customer-visible responses.
+          sig do
+            returns(
+              T.nilable(
+                Telnyx::Models::Dir::CommentCreateResponse::Data::CommentType::TaggedSymbol
+              )
+            )
+          end
+          attr_reader :comment_type
+
+          sig do
+            params(
+              comment_type:
+                Telnyx::Models::Dir::CommentCreateResponse::Data::CommentType::OrSymbol
+            ).void
+          end
+          attr_writer :comment_type
+
+          sig { returns(T.nilable(String)) }
+          attr_reader :content
+
+          sig { params(content: String).void }
+          attr_writer :content
+
+          sig { returns(T.nilable(String)) }
+          attr_reader :id
+
+          sig { params(id: String).void }
+          attr_writer :id
+
+          # Display name of the author. May be `null`.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :author_name
+
+          # Who wrote the comment. `admin` covers the Telnyx vetting team.
+          sig do
+            returns(
+              T.nilable(
+                Telnyx::Models::Dir::CommentCreateResponse::Data::AuthorRole::TaggedSymbol
+              )
+            )
+          end
+          attr_reader :author_role
+
+          sig do
+            params(
+              author_role:
+                Telnyx::Models::Dir::CommentCreateResponse::Data::AuthorRole::OrSymbol
+            ).void
+          end
+          attr_writer :author_role
+
+          sig { returns(T.nilable(Time)) }
+          attr_reader :created_at
+
+          sig { params(created_at: Time).void }
+          attr_writer :created_at
+
+          # Resource the comment is attached to. Always `dir` on this endpoint.
+          sig do
+            returns(
+              T.nilable(
+                Telnyx::Models::Dir::CommentCreateResponse::Data::EntityType::TaggedSymbol
+              )
+            )
+          end
+          attr_reader :entity_type
+
+          sig do
+            params(
+              entity_type:
+                Telnyx::Models::Dir::CommentCreateResponse::Data::EntityType::OrSymbol
+            ).void
+          end
+          attr_writer :entity_type
+
+          # Always `customer` on this endpoint - internal-only comments are filtered out.
+          sig do
+            returns(
+              T.nilable(
+                Telnyx::Models::Dir::CommentCreateResponse::Data::Visibility::TaggedSymbol
+              )
+            )
+          end
+          attr_reader :visibility
+
+          sig do
+            params(
+              visibility:
+                Telnyx::Models::Dir::CommentCreateResponse::Data::Visibility::OrSymbol
+            ).void
+          end
+          attr_writer :visibility
+
+          sig do
+            params(
+              id: String,
+              author_name: T.nilable(String),
+              author_role:
+                Telnyx::Models::Dir::CommentCreateResponse::Data::AuthorRole::OrSymbol,
+              comment_type:
+                Telnyx::Models::Dir::CommentCreateResponse::Data::CommentType::OrSymbol,
+              content: String,
+              created_at: Time,
+              entity_type:
+                Telnyx::Models::Dir::CommentCreateResponse::Data::EntityType::OrSymbol,
+              visibility:
+                Telnyx::Models::Dir::CommentCreateResponse::Data::Visibility::OrSymbol
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            id: nil,
+            # Display name of the author. May be `null`.
+            author_name: nil,
+            # Who wrote the comment. `admin` covers the Telnyx vetting team.
+            author_role: nil,
+            # Comment categorisation. Customers post `customer_inquiry`. The Telnyx team posts
+            # `vetting_comment`, `rejection_reason`, `notification`, `status_update`, or
+            # `admin_response`. `internal_note` is filtered out of customer-visible responses.
+            comment_type: nil,
+            content: nil,
+            created_at: nil,
+            # Resource the comment is attached to. Always `dir` on this endpoint.
+            entity_type: nil,
+            # Always `customer` on this endpoint - internal-only comments are filtered out.
+            visibility: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                id: String,
+                author_name: T.nilable(String),
+                author_role:
+                  Telnyx::Models::Dir::CommentCreateResponse::Data::AuthorRole::TaggedSymbol,
+                comment_type:
+                  Telnyx::Models::Dir::CommentCreateResponse::Data::CommentType::TaggedSymbol,
+                content: String,
+                created_at: Time,
+                entity_type:
+                  Telnyx::Models::Dir::CommentCreateResponse::Data::EntityType::TaggedSymbol,
+                visibility:
+                  Telnyx::Models::Dir::CommentCreateResponse::Data::Visibility::TaggedSymbol
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # Who wrote the comment. `admin` covers the Telnyx vetting team.
+          module AuthorRole
+            extend Telnyx::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Telnyx::Models::Dir::CommentCreateResponse::Data::AuthorRole
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            CUSTOMER =
+              T.let(
+                :customer,
+                Telnyx::Models::Dir::CommentCreateResponse::Data::AuthorRole::TaggedSymbol
+              )
+            ADMIN =
+              T.let(
+                :admin,
+                Telnyx::Models::Dir::CommentCreateResponse::Data::AuthorRole::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Telnyx::Models::Dir::CommentCreateResponse::Data::AuthorRole::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+
+          # Comment categorisation. Customers post `customer_inquiry`. The Telnyx team posts
+          # `vetting_comment`, `rejection_reason`, `notification`, `status_update`, or
+          # `admin_response`. `internal_note` is filtered out of customer-visible responses.
+          module CommentType
+            extend Telnyx::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Telnyx::Models::Dir::CommentCreateResponse::Data::CommentType
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            VETTING_COMMENT =
+              T.let(
+                :vetting_comment,
+                Telnyx::Models::Dir::CommentCreateResponse::Data::CommentType::TaggedSymbol
+              )
+            REJECTION_REASON =
+              T.let(
+                :rejection_reason,
+                Telnyx::Models::Dir::CommentCreateResponse::Data::CommentType::TaggedSymbol
+              )
+            INTERNAL_NOTE =
+              T.let(
+                :internal_note,
+                Telnyx::Models::Dir::CommentCreateResponse::Data::CommentType::TaggedSymbol
+              )
+            NOTIFICATION =
+              T.let(
+                :notification,
+                Telnyx::Models::Dir::CommentCreateResponse::Data::CommentType::TaggedSymbol
+              )
+            STATUS_UPDATE =
+              T.let(
+                :status_update,
+                Telnyx::Models::Dir::CommentCreateResponse::Data::CommentType::TaggedSymbol
+              )
+            CUSTOMER_INQUIRY =
+              T.let(
+                :customer_inquiry,
+                Telnyx::Models::Dir::CommentCreateResponse::Data::CommentType::TaggedSymbol
+              )
+            ADMIN_RESPONSE =
+              T.let(
+                :admin_response,
+                Telnyx::Models::Dir::CommentCreateResponse::Data::CommentType::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Telnyx::Models::Dir::CommentCreateResponse::Data::CommentType::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+
+          # Resource the comment is attached to. Always `dir` on this endpoint.
+          module EntityType
+            extend Telnyx::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Telnyx::Models::Dir::CommentCreateResponse::Data::EntityType
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            DIR =
+              T.let(
+                :dir,
+                Telnyx::Models::Dir::CommentCreateResponse::Data::EntityType::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Telnyx::Models::Dir::CommentCreateResponse::Data::EntityType::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+
+          # Always `customer` on this endpoint - internal-only comments are filtered out.
+          module Visibility
+            extend Telnyx::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Telnyx::Models::Dir::CommentCreateResponse::Data::Visibility
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            CUSTOMER =
+              T.let(
+                :customer,
+                Telnyx::Models::Dir::CommentCreateResponse::Data::Visibility::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Telnyx::Models::Dir::CommentCreateResponse::Data::Visibility::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/dir/comment_list_params.rbi

@@ -0,0 +1,145 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Dir
+      class CommentListParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(Telnyx::Dir::CommentListParams, Telnyx::Internal::AnyHash)
+          end
+
+        sig { returns(String) }
+        attr_accessor :dir_id
+
+        # Restrict to comments of this category. Customer-visible categories only:
+        # internal-only comments are filtered out regardless of this filter.
+        sig do
+          returns(
+            T.nilable(Telnyx::Dir::CommentListParams::CommentType::OrSymbol)
+          )
+        end
+        attr_reader :comment_type
+
+        sig do
+          params(
+            comment_type: Telnyx::Dir::CommentListParams::CommentType::OrSymbol
+          ).void
+        end
+        attr_writer :comment_type
+
+        # 1-based page number. Out-of-range values return an empty page with correct meta.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :page_number
+
+        sig { params(page_number: Integer).void }
+        attr_writer :page_number
+
+        # Items per page. Maximum 250; values above are clamped to 250.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :page_size
+
+        sig { params(page_size: Integer).void }
+        attr_writer :page_size
+
+        sig do
+          params(
+            dir_id: String,
+            comment_type: Telnyx::Dir::CommentListParams::CommentType::OrSymbol,
+            page_number: Integer,
+            page_size: Integer,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          dir_id:,
+          # Restrict to comments of this category. Customer-visible categories only:
+          # internal-only comments are filtered out regardless of this filter.
+          comment_type: nil,
+          # 1-based page number. Out-of-range values return an empty page with correct meta.
+          page_number: nil,
+          # Items per page. Maximum 250; values above are clamped to 250.
+          page_size: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              dir_id: String,
+              comment_type:
+                Telnyx::Dir::CommentListParams::CommentType::OrSymbol,
+              page_number: Integer,
+              page_size: Integer,
+              request_options: Telnyx::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # Restrict to comments of this category. Customer-visible categories only:
+        # internal-only comments are filtered out regardless of this filter.
+        module CommentType
+          extend Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Telnyx::Dir::CommentListParams::CommentType)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          VETTING_COMMENT =
+            T.let(
+              :vetting_comment,
+              Telnyx::Dir::CommentListParams::CommentType::TaggedSymbol
+            )
+          REJECTION_REASON =
+            T.let(
+              :rejection_reason,
+              Telnyx::Dir::CommentListParams::CommentType::TaggedSymbol
+            )
+          INTERNAL_NOTE =
+            T.let(
+              :internal_note,
+              Telnyx::Dir::CommentListParams::CommentType::TaggedSymbol
+            )
+          NOTIFICATION =
+            T.let(
+              :notification,
+              Telnyx::Dir::CommentListParams::CommentType::TaggedSymbol
+            )
+          STATUS_UPDATE =
+            T.let(
+              :status_update,
+              Telnyx::Dir::CommentListParams::CommentType::TaggedSymbol
+            )
+          CUSTOMER_INQUIRY =
+            T.let(
+              :customer_inquiry,
+              Telnyx::Dir::CommentListParams::CommentType::TaggedSymbol
+            )
+          ADMIN_RESPONSE =
+            T.let(
+              :admin_response,
+              Telnyx::Dir::CommentListParams::CommentType::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Telnyx::Dir::CommentListParams::CommentType::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end