telnyx 5.0.0 → 5.2.0

data/rbi/telnyx/models/organizations/user_get_groups_report_params.rbi

@@ -0,0 +1,93 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Organizations
+      class UserGetGroupsReportParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::Organizations::UserGetGroupsReportParams,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        sig do
+          returns(
+            T.nilable(
+              Telnyx::Organizations::UserGetGroupsReportParams::Accept::OrSymbol
+            )
+          )
+        end
+        attr_reader :accept
+
+        sig do
+          params(
+            accept:
+              Telnyx::Organizations::UserGetGroupsReportParams::Accept::OrSymbol
+          ).void
+        end
+        attr_writer :accept
+
+        sig do
+          params(
+            accept:
+              Telnyx::Organizations::UserGetGroupsReportParams::Accept::OrSymbol,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(accept: nil, request_options: {})
+        end
+
+        sig do
+          override.returns(
+            {
+              accept:
+                Telnyx::Organizations::UserGetGroupsReportParams::Accept::OrSymbol,
+              request_options: Telnyx::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+
+        module Accept
+          extend Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Telnyx::Organizations::UserGetGroupsReportParams::Accept
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          APPLICATION_JSON =
+            T.let(
+              :"application/json",
+              Telnyx::Organizations::UserGetGroupsReportParams::Accept::TaggedSymbol
+            )
+          TEXT_CSV =
+            T.let(
+              :"text/csv",
+              Telnyx::Organizations::UserGetGroupsReportParams::Accept::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Telnyx::Organizations::UserGetGroupsReportParams::Accept::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/organizations/user_get_groups_report_response.rbi

@@ -0,0 +1,210 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Organizations
+      class UserGetGroupsReportResponse < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::Models::Organizations::UserGetGroupsReportResponse,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        sig do
+          returns(
+            T.nilable(
+              T::Array[
+                Telnyx::Models::Organizations::UserGetGroupsReportResponse::Data
+              ]
+            )
+          )
+        end
+        attr_reader :data
+
+        sig do
+          params(
+            data:
+              T::Array[
+                Telnyx::Models::Organizations::UserGetGroupsReportResponse::Data::OrHash
+              ]
+          ).void
+        end
+        attr_writer :data
+
+        sig do
+          params(
+            data:
+              T::Array[
+                Telnyx::Models::Organizations::UserGetGroupsReportResponse::Data::OrHash
+              ]
+          ).returns(T.attached_class)
+        end
+        def self.new(data: nil)
+        end
+
+        sig do
+          override.returns(
+            {
+              data:
+                T::Array[
+                  Telnyx::Models::Organizations::UserGetGroupsReportResponse::Data
+                ]
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Data < Telnyx::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Telnyx::Models::Organizations::UserGetGroupsReportResponse::Data,
+                Telnyx::Internal::AnyHash
+              )
+            end
+
+          # Identifies the specific resource.
+          sig { returns(String) }
+          attr_accessor :id
+
+          # ISO 8601 formatted date indicating when the resource was created.
+          sig { returns(String) }
+          attr_accessor :created_at
+
+          # The email address of the user.
+          sig { returns(String) }
+          attr_accessor :email
+
+          # The groups the user belongs to.
+          sig { returns(T::Array[Telnyx::Organizations::UserGroupReference]) }
+          attr_accessor :groups
+
+          # Identifies the type of the resource. Can be 'organization_owner' or
+          # 'organization_sub_user'.
+          sig { returns(String) }
+          attr_accessor :record_type
+
+          # The status of the account.
+          sig do
+            returns(
+              Telnyx::Models::Organizations::UserGetGroupsReportResponse::Data::UserStatus::TaggedSymbol
+            )
+          end
+          attr_accessor :user_status
+
+          # ISO 8601 formatted date indicating when the resource last signed into the
+          # portal. Null if the user has never signed in.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :last_sign_in_at
+
+          # Indicates whether this user is allowed to bypass SSO and use password
+          # authentication.
+          sig { returns(T.nilable(T::Boolean)) }
+          attr_reader :organization_user_bypasses_sso
+
+          sig { params(organization_user_bypasses_sso: T::Boolean).void }
+          attr_writer :organization_user_bypasses_sso
+
+          # An organization user with their group memberships always included.
+          sig do
+            params(
+              id: String,
+              created_at: String,
+              email: String,
+              groups:
+                T::Array[Telnyx::Organizations::UserGroupReference::OrHash],
+              record_type: String,
+              user_status:
+                Telnyx::Models::Organizations::UserGetGroupsReportResponse::Data::UserStatus::OrSymbol,
+              last_sign_in_at: T.nilable(String),
+              organization_user_bypasses_sso: T::Boolean
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Identifies the specific resource.
+            id:,
+            # ISO 8601 formatted date indicating when the resource was created.
+            created_at:,
+            # The email address of the user.
+            email:,
+            # The groups the user belongs to.
+            groups:,
+            # Identifies the type of the resource. Can be 'organization_owner' or
+            # 'organization_sub_user'.
+            record_type:,
+            # The status of the account.
+            user_status:,
+            # ISO 8601 formatted date indicating when the resource last signed into the
+            # portal. Null if the user has never signed in.
+            last_sign_in_at: nil,
+            # Indicates whether this user is allowed to bypass SSO and use password
+            # authentication.
+            organization_user_bypasses_sso: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                id: String,
+                created_at: String,
+                email: String,
+                groups: T::Array[Telnyx::Organizations::UserGroupReference],
+                record_type: String,
+                user_status:
+                  Telnyx::Models::Organizations::UserGetGroupsReportResponse::Data::UserStatus::TaggedSymbol,
+                last_sign_in_at: T.nilable(String),
+                organization_user_bypasses_sso: T::Boolean
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # The status of the account.
+          module UserStatus
+            extend Telnyx::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Telnyx::Models::Organizations::UserGetGroupsReportResponse::Data::UserStatus
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            ENABLED =
+              T.let(
+                :enabled,
+                Telnyx::Models::Organizations::UserGetGroupsReportResponse::Data::UserStatus::TaggedSymbol
+              )
+            DISABLED =
+              T.let(
+                :disabled,
+                Telnyx::Models::Organizations::UserGetGroupsReportResponse::Data::UserStatus::TaggedSymbol
+              )
+            BLOCKED =
+              T.let(
+                :blocked,
+                Telnyx::Models::Organizations::UserGetGroupsReportResponse::Data::UserStatus::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Telnyx::Models::Organizations::UserGetGroupsReportResponse::Data::UserStatus::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/organizations/user_group_reference.rbi

@@ -0,0 +1,39 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Organizations
+      class UserGroupReference < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::Organizations::UserGroupReference,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        # The unique identifier of the group.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The name of the group.
+        sig { returns(String) }
+        attr_accessor :name
+
+        # A reference to a group that a user belongs to.
+        sig { params(id: String, name: String).returns(T.attached_class) }
+        def self.new(
+          # The unique identifier of the group.
+          id:,
+          # The name of the group.
+          name:
+        )
+        end
+
+        sig { override.returns({ id: String, name: String }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/organizations/user_list_params.rbi

@@ -0,0 +1,152 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Organizations
+      class UserListParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::Organizations::UserListParams,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        # Filter by email address (partial match)
+        sig { returns(T.nilable(String)) }
+        attr_reader :filter_email
+
+        sig { params(filter_email: String).void }
+        attr_writer :filter_email
+
+        # Filter by user status
+        sig do
+          returns(
+            T.nilable(
+              Telnyx::Organizations::UserListParams::FilterUserStatus::OrSymbol
+            )
+          )
+        end
+        attr_reader :filter_user_status
+
+        sig do
+          params(
+            filter_user_status:
+              Telnyx::Organizations::UserListParams::FilterUserStatus::OrSymbol
+          ).void
+        end
+        attr_writer :filter_user_status
+
+        # When set to true, includes the groups array for each user in the response. The
+        # groups array contains objects with id and name for each group the user belongs
+        # to.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :include_groups
+
+        sig { params(include_groups: T::Boolean).void }
+        attr_writer :include_groups
+
+        # The page number to load
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :page_number
+
+        sig { params(page_number: Integer).void }
+        attr_writer :page_number
+
+        # The size of the page
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :page_size
+
+        sig { params(page_size: Integer).void }
+        attr_writer :page_size
+
+        sig do
+          params(
+            filter_email: String,
+            filter_user_status:
+              Telnyx::Organizations::UserListParams::FilterUserStatus::OrSymbol,
+            include_groups: T::Boolean,
+            page_number: Integer,
+            page_size: Integer,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Filter by email address (partial match)
+          filter_email: nil,
+          # Filter by user status
+          filter_user_status: nil,
+          # When set to true, includes the groups array for each user in the response. The
+          # groups array contains objects with id and name for each group the user belongs
+          # to.
+          include_groups: nil,
+          # The page number to load
+          page_number: nil,
+          # The size of the page
+          page_size: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              filter_email: String,
+              filter_user_status:
+                Telnyx::Organizations::UserListParams::FilterUserStatus::OrSymbol,
+              include_groups: T::Boolean,
+              page_number: Integer,
+              page_size: Integer,
+              request_options: Telnyx::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # Filter by user status
+        module FilterUserStatus
+          extend Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Telnyx::Organizations::UserListParams::FilterUserStatus
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          ENABLED =
+            T.let(
+              :enabled,
+              Telnyx::Organizations::UserListParams::FilterUserStatus::TaggedSymbol
+            )
+          DISABLED =
+            T.let(
+              :disabled,
+              Telnyx::Organizations::UserListParams::FilterUserStatus::TaggedSymbol
+            )
+          BLOCKED =
+            T.let(
+              :blocked,
+              Telnyx::Organizations::UserListParams::FilterUserStatus::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Telnyx::Organizations::UserListParams::FilterUserStatus::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/organizations/user_list_response.rbi

@@ -0,0 +1,188 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Organizations
+      class UserListResponse < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::Models::Organizations::UserListResponse,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        # Identifies the specific resource.
+        sig { returns(T.nilable(String)) }
+        attr_reader :id
+
+        sig { params(id: String).void }
+        attr_writer :id
+
+        # ISO 8601 formatted date indicating when the resource was created.
+        sig { returns(T.nilable(String)) }
+        attr_reader :created_at
+
+        sig { params(created_at: String).void }
+        attr_writer :created_at
+
+        # The email address of the user.
+        sig { returns(T.nilable(String)) }
+        attr_reader :email
+
+        sig { params(email: String).void }
+        attr_writer :email
+
+        # The groups the user belongs to. Only included when include_groups parameter is
+        # true.
+        sig do
+          returns(
+            T.nilable(T::Array[Telnyx::Organizations::UserGroupReference])
+          )
+        end
+        attr_reader :groups
+
+        sig do
+          params(
+            groups: T::Array[Telnyx::Organizations::UserGroupReference::OrHash]
+          ).void
+        end
+        attr_writer :groups
+
+        # ISO 8601 formatted date indicating when the resource last signed into the
+        # portal. Null if the user has never signed in.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :last_sign_in_at
+
+        # Indicates whether this user is allowed to bypass SSO and use password
+        # authentication.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :organization_user_bypasses_sso
+
+        sig { params(organization_user_bypasses_sso: T::Boolean).void }
+        attr_writer :organization_user_bypasses_sso
+
+        # Identifies the type of the resource. Can be 'organization_owner' or
+        # 'organization_sub_user'.
+        sig { returns(T.nilable(String)) }
+        attr_reader :record_type
+
+        sig { params(record_type: String).void }
+        attr_writer :record_type
+
+        # The status of the account.
+        sig do
+          returns(
+            T.nilable(
+              Telnyx::Models::Organizations::UserListResponse::UserStatus::TaggedSymbol
+            )
+          )
+        end
+        attr_reader :user_status
+
+        sig do
+          params(
+            user_status:
+              Telnyx::Models::Organizations::UserListResponse::UserStatus::OrSymbol
+          ).void
+        end
+        attr_writer :user_status
+
+        sig do
+          params(
+            id: String,
+            created_at: String,
+            email: String,
+            groups: T::Array[Telnyx::Organizations::UserGroupReference::OrHash],
+            last_sign_in_at: T.nilable(String),
+            organization_user_bypasses_sso: T::Boolean,
+            record_type: String,
+            user_status:
+              Telnyx::Models::Organizations::UserListResponse::UserStatus::OrSymbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Identifies the specific resource.
+          id: nil,
+          # ISO 8601 formatted date indicating when the resource was created.
+          created_at: nil,
+          # The email address of the user.
+          email: nil,
+          # The groups the user belongs to. Only included when include_groups parameter is
+          # true.
+          groups: nil,
+          # ISO 8601 formatted date indicating when the resource last signed into the
+          # portal. Null if the user has never signed in.
+          last_sign_in_at: nil,
+          # Indicates whether this user is allowed to bypass SSO and use password
+          # authentication.
+          organization_user_bypasses_sso: nil,
+          # Identifies the type of the resource. Can be 'organization_owner' or
+          # 'organization_sub_user'.
+          record_type: nil,
+          # The status of the account.
+          user_status: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              created_at: String,
+              email: String,
+              groups: T::Array[Telnyx::Organizations::UserGroupReference],
+              last_sign_in_at: T.nilable(String),
+              organization_user_bypasses_sso: T::Boolean,
+              record_type: String,
+              user_status:
+                Telnyx::Models::Organizations::UserListResponse::UserStatus::TaggedSymbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # The status of the account.
+        module UserStatus
+          extend Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Telnyx::Models::Organizations::UserListResponse::UserStatus
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          ENABLED =
+            T.let(
+              :enabled,
+              Telnyx::Models::Organizations::UserListResponse::UserStatus::TaggedSymbol
+            )
+          DISABLED =
+            T.let(
+              :disabled,
+              Telnyx::Models::Organizations::UserListResponse::UserStatus::TaggedSymbol
+            )
+          BLOCKED =
+            T.let(
+              :blocked,
+              Telnyx::Models::Organizations::UserListResponse::UserStatus::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Telnyx::Models::Organizations::UserListResponse::UserStatus::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end