telnyx 5.0.0 → 5.2.0

data/rbi/telnyx/models/organizations/user_retrieve_params.rbi

@@ -0,0 +1,55 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Organizations
+      class UserRetrieveParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::Organizations::UserRetrieveParams,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        # 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
+
+        sig do
+          params(
+            include_groups: T::Boolean,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # 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,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              include_groups: T::Boolean,
+              request_options: Telnyx::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/organizations/user_retrieve_response.rbi

@@ -0,0 +1,232 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Organizations
+      class UserRetrieveResponse < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::Models::Organizations::UserRetrieveResponse,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        sig do
+          returns(
+            T.nilable(Telnyx::Models::Organizations::UserRetrieveResponse::Data)
+          )
+        end
+        attr_reader :data
+
+        sig do
+          params(
+            data:
+              Telnyx::Models::Organizations::UserRetrieveResponse::Data::OrHash
+          ).void
+        end
+        attr_writer :data
+
+        sig do
+          params(
+            data:
+              Telnyx::Models::Organizations::UserRetrieveResponse::Data::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(data: nil)
+        end
+
+        sig do
+          override.returns(
+            { data: Telnyx::Models::Organizations::UserRetrieveResponse::Data }
+          )
+        end
+        def to_hash
+        end
+
+        class Data < Telnyx::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Telnyx::Models::Organizations::UserRetrieveResponse::Data,
+                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::UserRetrieveResponse::Data::UserStatus::TaggedSymbol
+              )
+            )
+          end
+          attr_reader :user_status
+
+          sig do
+            params(
+              user_status:
+                Telnyx::Models::Organizations::UserRetrieveResponse::Data::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::UserRetrieveResponse::Data::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::UserRetrieveResponse::Data::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::UserRetrieveResponse::Data::UserStatus
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            ENABLED =
+              T.let(
+                :enabled,
+                Telnyx::Models::Organizations::UserRetrieveResponse::Data::UserStatus::TaggedSymbol
+              )
+            DISABLED =
+              T.let(
+                :disabled,
+                Telnyx::Models::Organizations::UserRetrieveResponse::Data::UserStatus::TaggedSymbol
+              )
+            BLOCKED =
+              T.let(
+                :blocked,
+                Telnyx::Models::Organizations::UserRetrieveResponse::Data::UserStatus::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Telnyx::Models::Organizations::UserRetrieveResponse::Data::UserStatus::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/organizations/users/action_remove_params.rbi

@@ -0,0 +1,34 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Organizations
+      module Users
+        class ActionRemoveParams < Telnyx::Internal::Type::BaseModel
+          extend Telnyx::Internal::Type::RequestParameters::Converter
+          include Telnyx::Internal::Type::RequestParameters
+
+          OrHash =
+            T.type_alias do
+              T.any(
+                Telnyx::Organizations::Users::ActionRemoveParams,
+                Telnyx::Internal::AnyHash
+              )
+            end
+
+          sig do
+            params(request_options: Telnyx::RequestOptions::OrHash).returns(
+              T.attached_class
+            )
+          end
+          def self.new(request_options: {})
+          end
+
+          sig { override.returns({ request_options: Telnyx::RequestOptions }) }
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/organizations/users/action_remove_response.rbi

@@ -0,0 +1,239 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Organizations
+      module Users
+        class ActionRemoveResponse < Telnyx::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Telnyx::Models::Organizations::Users::ActionRemoveResponse,
+                Telnyx::Internal::AnyHash
+              )
+            end
+
+          sig do
+            returns(
+              T.nilable(
+                Telnyx::Models::Organizations::Users::ActionRemoveResponse::Data
+              )
+            )
+          end
+          attr_reader :data
+
+          sig do
+            params(
+              data:
+                Telnyx::Models::Organizations::Users::ActionRemoveResponse::Data::OrHash
+            ).void
+          end
+          attr_writer :data
+
+          sig do
+            params(
+              data:
+                Telnyx::Models::Organizations::Users::ActionRemoveResponse::Data::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(data: nil)
+          end
+
+          sig do
+            override.returns(
+              {
+                data:
+                  Telnyx::Models::Organizations::Users::ActionRemoveResponse::Data
+              }
+            )
+          end
+          def to_hash
+          end
+
+          class Data < Telnyx::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Telnyx::Models::Organizations::Users::ActionRemoveResponse::Data,
+                  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::Users::ActionRemoveResponse::Data::UserStatus::TaggedSymbol
+                )
+              )
+            end
+            attr_reader :user_status
+
+            sig do
+              params(
+                user_status:
+                  Telnyx::Models::Organizations::Users::ActionRemoveResponse::Data::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::Users::ActionRemoveResponse::Data::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::Users::ActionRemoveResponse::Data::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::Users::ActionRemoveResponse::Data::UserStatus
+                  )
+                end
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+              ENABLED =
+                T.let(
+                  :enabled,
+                  Telnyx::Models::Organizations::Users::ActionRemoveResponse::Data::UserStatus::TaggedSymbol
+                )
+              DISABLED =
+                T.let(
+                  :disabled,
+                  Telnyx::Models::Organizations::Users::ActionRemoveResponse::Data::UserStatus::TaggedSymbol
+                )
+              BLOCKED =
+                T.let(
+                  :blocked,
+                  Telnyx::Models::Organizations::Users::ActionRemoveResponse::Data::UserStatus::TaggedSymbol
+                )
+
+              sig do
+                override.returns(
+                  T::Array[
+                    Telnyx::Models::Organizations::Users::ActionRemoveResponse::Data::UserStatus::TaggedSymbol
+                  ]
+                )
+              end
+              def self.values
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/private_wireless_gateway_status.rbi

@@ -8,7 +8,8 @@ module Telnyx
           T.any(Telnyx::PrivateWirelessGatewayStatus, Telnyx::Internal::AnyHash)
         end
 
-      # This attribute is an [error code](https://developers.telnyx.com/api/errors)
+      # This attribute is an
+      # [error code](https://developers.telnyx.com/development/api-fundamentals/api-errors)
       # related to the failure reason.
       sig { returns(T.nilable(String)) }
       attr_accessor :error_code
@@ -48,7 +49,8 @@ module Telnyx
         ).returns(T.attached_class)
       end
       def self.new(
-        # This attribute is an [error code](https://developers.telnyx.com/api/errors)
+        # This attribute is an
+        # [error code](https://developers.telnyx.com/development/api-fundamentals/api-errors)
         # related to the failure reason.
         error_code: nil,
         # This attribute provides a human-readable explanation of why a failure happened.

data/rbi/telnyx/models/queues/call_list_params.rbi

@@ -20,9 +20,23 @@ module Telnyx
         sig { params(page: Telnyx::Queues::CallListParams::Page::OrHash).void }
         attr_writer :page
 
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :page_number
+
+        sig { params(page_number: Integer).void }
+        attr_writer :page_number
+
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :page_size
+
+        sig { params(page_size: Integer).void }
+        attr_writer :page_size
+
         sig do
           params(
             page: Telnyx::Queues::CallListParams::Page::OrHash,
+            page_number: Integer,
+            page_size: Integer,
             request_options: Telnyx::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
@@ -30,6 +44,8 @@ module Telnyx
           # Consolidated page parameter (deepObject style). Originally: page[after],
           # page[before], page[limit], page[size], page[number]
           page: nil,
+          page_number: nil,
+          page_size: nil,
           request_options: {}
         )
         end
@@ -38,6 +54,8 @@ module Telnyx
           override.returns(
             {
               page: Telnyx::Queues::CallListParams::Page,
+              page_number: Integer,
+              page_size: Integer,
               request_options: Telnyx::RequestOptions
             }
           )
@@ -75,30 +93,12 @@ module Telnyx
           sig { params(limit: Integer).void }
           attr_writer :limit
 
-          # The page number to load
-          sig { returns(T.nilable(Integer)) }
-          attr_reader :number
-
-          sig { params(number: Integer).void }
-          attr_writer :number
-
-          # The size of the page
-          sig { returns(T.nilable(Integer)) }
-          attr_reader :size
-
-          sig { params(size: Integer).void }
-          attr_writer :size
-
           # Consolidated page parameter (deepObject style). Originally: page[after],
           # page[before], page[limit], page[size], page[number]
           sig do
-            params(
-              after: String,
-              before: String,
-              limit: Integer,
-              number: Integer,
-              size: Integer
-            ).returns(T.attached_class)
+            params(after: String, before: String, limit: Integer).returns(
+              T.attached_class
+            )
           end
           def self.new(
             # Opaque identifier of next page
@@ -106,24 +106,12 @@ module Telnyx
             # Opaque identifier of previous page
             before: nil,
             # Limit of records per single page
-            limit: nil,
-            # The page number to load
-            number: nil,
-            # The size of the page
-            size: nil
+            limit: nil
           )
           end
 
           sig do
-            override.returns(
-              {
-                after: String,
-                before: String,
-                limit: Integer,
-                number: Integer,
-                size: Integer
-              }
-            )
+            override.returns({ after: String, before: String, limit: Integer })
           end
           def to_hash
           end