telnyx 5.0.0 → 5.2.0

data/lib/telnyx/models/organizations/user_get_groups_report_response.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Organizations
+      # @see Telnyx::Resources::Organizations::Users#get_groups_report
+      class UserGetGroupsReportResponse < Telnyx::Internal::Type::BaseModel
+        # @!attribute data
+        #
+        #   @return [Array<Telnyx::Models::Organizations::UserGetGroupsReportResponse::Data>, nil]
+        optional :data,
+                 -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Models::Organizations::UserGetGroupsReportResponse::Data] }
+
+        # @!method initialize(data: nil)
+        #   @param data [Array<Telnyx::Models::Organizations::UserGetGroupsReportResponse::Data>]
+
+        class Data < Telnyx::Internal::Type::BaseModel
+          # @!attribute id
+          #   Identifies the specific resource.
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute created_at
+          #   ISO 8601 formatted date indicating when the resource was created.
+          #
+          #   @return [String]
+          required :created_at, String
+
+          # @!attribute email
+          #   The email address of the user.
+          #
+          #   @return [String]
+          required :email, String
+
+          # @!attribute groups
+          #   The groups the user belongs to.
+          #
+          #   @return [Array<Telnyx::Models::Organizations::UserGroupReference>]
+          required :groups, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Organizations::UserGroupReference] }
+
+          # @!attribute record_type
+          #   Identifies the type of the resource. Can be 'organization_owner' or
+          #   'organization_sub_user'.
+          #
+          #   @return [String]
+          required :record_type, String
+
+          # @!attribute user_status
+          #   The status of the account.
+          #
+          #   @return [Symbol, Telnyx::Models::Organizations::UserGetGroupsReportResponse::Data::UserStatus]
+          required :user_status,
+                   enum: -> { Telnyx::Models::Organizations::UserGetGroupsReportResponse::Data::UserStatus }
+
+          # @!attribute last_sign_in_at
+          #   ISO 8601 formatted date indicating when the resource last signed into the
+          #   portal. Null if the user has never signed in.
+          #
+          #   @return [String, nil]
+          optional :last_sign_in_at, String, nil?: true
+
+          # @!attribute organization_user_bypasses_sso
+          #   Indicates whether this user is allowed to bypass SSO and use password
+          #   authentication.
+          #
+          #   @return [Boolean, nil]
+          optional :organization_user_bypasses_sso, Telnyx::Internal::Type::Boolean
+
+          # @!method initialize(id:, created_at:, email:, groups:, record_type:, user_status:, last_sign_in_at: nil, organization_user_bypasses_sso: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Telnyx::Models::Organizations::UserGetGroupsReportResponse::Data} for more
+          #   details.
+          #
+          #   An organization user with their group memberships always included.
+          #
+          #   @param id [String] Identifies the specific resource.
+          #
+          #   @param created_at [String] ISO 8601 formatted date indicating when the resource was created.
+          #
+          #   @param email [String] The email address of the user.
+          #
+          #   @param groups [Array<Telnyx::Models::Organizations::UserGroupReference>] The groups the user belongs to.
+          #
+          #   @param record_type [String] Identifies the type of the resource. Can be 'organization_owner' or 'organizatio
+          #
+          #   @param user_status [Symbol, Telnyx::Models::Organizations::UserGetGroupsReportResponse::Data::UserStatus] The status of the account.
+          #
+          #   @param last_sign_in_at [String, nil] ISO 8601 formatted date indicating when the resource last signed into the portal
+          #
+          #   @param organization_user_bypasses_sso [Boolean] Indicates whether this user is allowed to bypass SSO and use password authentica
+
+          # The status of the account.
+          #
+          # @see Telnyx::Models::Organizations::UserGetGroupsReportResponse::Data#user_status
+          module UserStatus
+            extend Telnyx::Internal::Type::Enum
+
+            ENABLED = :enabled
+            DISABLED = :disabled
+            BLOCKED = :blocked
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/organizations/user_group_reference.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Organizations
+      class UserGroupReference < Telnyx::Internal::Type::BaseModel
+        # @!attribute id
+        #   The unique identifier of the group.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute name
+        #   The name of the group.
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!method initialize(id:, name:)
+        #   A reference to a group that a user belongs to.
+        #
+        #   @param id [String] The unique identifier of the group.
+        #
+        #   @param name [String] The name of the group.
+      end
+    end
+  end
+end

data/lib/telnyx/models/organizations/user_list_params.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Organizations
+      # @see Telnyx::Resources::Organizations::Users#list
+      class UserListParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        # @!attribute filter_email
+        #   Filter by email address (partial match)
+        #
+        #   @return [String, nil]
+        optional :filter_email, String
+
+        # @!attribute filter_user_status
+        #   Filter by user status
+        #
+        #   @return [Symbol, Telnyx::Models::Organizations::UserListParams::FilterUserStatus, nil]
+        optional :filter_user_status, enum: -> { Telnyx::Organizations::UserListParams::FilterUserStatus }
+
+        # @!attribute include_groups
+        #   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.
+        #
+        #   @return [Boolean, nil]
+        optional :include_groups, Telnyx::Internal::Type::Boolean
+
+        # @!attribute page_number
+        #   The page number to load
+        #
+        #   @return [Integer, nil]
+        optional :page_number, Integer
+
+        # @!attribute page_size
+        #   The size of the page
+        #
+        #   @return [Integer, nil]
+        optional :page_size, Integer
+
+        # @!method initialize(filter_email: nil, filter_user_status: nil, include_groups: nil, page_number: nil, page_size: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::Organizations::UserListParams} for more details.
+        #
+        #   @param filter_email [String] Filter by email address (partial match)
+        #
+        #   @param filter_user_status [Symbol, Telnyx::Models::Organizations::UserListParams::FilterUserStatus] Filter by user status
+        #
+        #   @param include_groups [Boolean] When set to true, includes the groups array for each user in the response. The g
+        #
+        #   @param page_number [Integer] The page number to load
+        #
+        #   @param page_size [Integer] The size of the page
+        #
+        #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+
+        # Filter by user status
+        module FilterUserStatus
+          extend Telnyx::Internal::Type::Enum
+
+          ENABLED = :enabled
+          DISABLED = :disabled
+          BLOCKED = :blocked
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/organizations/user_list_response.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Organizations
+      # @see Telnyx::Resources::Organizations::Users#list
+      class UserListResponse < Telnyx::Internal::Type::BaseModel
+        # @!attribute id
+        #   Identifies the specific resource.
+        #
+        #   @return [String, nil]
+        optional :id, String
+
+        # @!attribute created_at
+        #   ISO 8601 formatted date indicating when the resource was created.
+        #
+        #   @return [String, nil]
+        optional :created_at, String
+
+        # @!attribute email
+        #   The email address of the user.
+        #
+        #   @return [String, nil]
+        optional :email, String
+
+        # @!attribute groups
+        #   The groups the user belongs to. Only included when include_groups parameter is
+        #   true.
+        #
+        #   @return [Array<Telnyx::Models::Organizations::UserGroupReference>, nil]
+        optional :groups, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Organizations::UserGroupReference] }
+
+        # @!attribute last_sign_in_at
+        #   ISO 8601 formatted date indicating when the resource last signed into the
+        #   portal. Null if the user has never signed in.
+        #
+        #   @return [String, nil]
+        optional :last_sign_in_at, String, nil?: true
+
+        # @!attribute organization_user_bypasses_sso
+        #   Indicates whether this user is allowed to bypass SSO and use password
+        #   authentication.
+        #
+        #   @return [Boolean, nil]
+        optional :organization_user_bypasses_sso, Telnyx::Internal::Type::Boolean
+
+        # @!attribute record_type
+        #   Identifies the type of the resource. Can be 'organization_owner' or
+        #   'organization_sub_user'.
+        #
+        #   @return [String, nil]
+        optional :record_type, String
+
+        # @!attribute user_status
+        #   The status of the account.
+        #
+        #   @return [Symbol, Telnyx::Models::Organizations::UserListResponse::UserStatus, nil]
+        optional :user_status, enum: -> { Telnyx::Models::Organizations::UserListResponse::UserStatus }
+
+        # @!method initialize(id: nil, created_at: nil, email: nil, groups: nil, last_sign_in_at: nil, organization_user_bypasses_sso: nil, record_type: nil, user_status: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::Organizations::UserListResponse} for more details.
+        #
+        #   @param id [String] Identifies the specific resource.
+        #
+        #   @param created_at [String] ISO 8601 formatted date indicating when the resource was created.
+        #
+        #   @param email [String] The email address of the user.
+        #
+        #   @param groups [Array<Telnyx::Models::Organizations::UserGroupReference>] The groups the user belongs to. Only included when include_groups parameter is t
+        #
+        #   @param last_sign_in_at [String, nil] ISO 8601 formatted date indicating when the resource last signed into the portal
+        #
+        #   @param organization_user_bypasses_sso [Boolean] Indicates whether this user is allowed to bypass SSO and use password authentica
+        #
+        #   @param record_type [String] Identifies the type of the resource. Can be 'organization_owner' or 'organizatio
+        #
+        #   @param user_status [Symbol, Telnyx::Models::Organizations::UserListResponse::UserStatus] The status of the account.
+
+        # The status of the account.
+        #
+        # @see Telnyx::Models::Organizations::UserListResponse#user_status
+        module UserStatus
+          extend Telnyx::Internal::Type::Enum
+
+          ENABLED = :enabled
+          DISABLED = :disabled
+          BLOCKED = :blocked
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/organizations/user_retrieve_params.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Organizations
+      # @see Telnyx::Resources::Organizations::Users#retrieve
+      class UserRetrieveParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        # @!attribute include_groups
+        #   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.
+        #
+        #   @return [Boolean, nil]
+        optional :include_groups, Telnyx::Internal::Type::Boolean
+
+        # @!method initialize(include_groups: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::Organizations::UserRetrieveParams} for more details.
+        #
+        #   @param include_groups [Boolean] When set to true, includes the groups array for each user in the response. The g
+        #
+        #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/telnyx/models/organizations/user_retrieve_response.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Organizations
+      # @see Telnyx::Resources::Organizations::Users#retrieve
+      class UserRetrieveResponse < Telnyx::Internal::Type::BaseModel
+        # @!attribute data
+        #
+        #   @return [Telnyx::Models::Organizations::UserRetrieveResponse::Data, nil]
+        optional :data, -> { Telnyx::Models::Organizations::UserRetrieveResponse::Data }
+
+        # @!method initialize(data: nil)
+        #   @param data [Telnyx::Models::Organizations::UserRetrieveResponse::Data]
+
+        # @see Telnyx::Models::Organizations::UserRetrieveResponse#data
+        class Data < Telnyx::Internal::Type::BaseModel
+          # @!attribute id
+          #   Identifies the specific resource.
+          #
+          #   @return [String, nil]
+          optional :id, String
+
+          # @!attribute created_at
+          #   ISO 8601 formatted date indicating when the resource was created.
+          #
+          #   @return [String, nil]
+          optional :created_at, String
+
+          # @!attribute email
+          #   The email address of the user.
+          #
+          #   @return [String, nil]
+          optional :email, String
+
+          # @!attribute groups
+          #   The groups the user belongs to. Only included when include_groups parameter is
+          #   true.
+          #
+          #   @return [Array<Telnyx::Models::Organizations::UserGroupReference>, nil]
+          optional :groups, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Organizations::UserGroupReference] }
+
+          # @!attribute last_sign_in_at
+          #   ISO 8601 formatted date indicating when the resource last signed into the
+          #   portal. Null if the user has never signed in.
+          #
+          #   @return [String, nil]
+          optional :last_sign_in_at, String, nil?: true
+
+          # @!attribute organization_user_bypasses_sso
+          #   Indicates whether this user is allowed to bypass SSO and use password
+          #   authentication.
+          #
+          #   @return [Boolean, nil]
+          optional :organization_user_bypasses_sso, Telnyx::Internal::Type::Boolean
+
+          # @!attribute record_type
+          #   Identifies the type of the resource. Can be 'organization_owner' or
+          #   'organization_sub_user'.
+          #
+          #   @return [String, nil]
+          optional :record_type, String
+
+          # @!attribute user_status
+          #   The status of the account.
+          #
+          #   @return [Symbol, Telnyx::Models::Organizations::UserRetrieveResponse::Data::UserStatus, nil]
+          optional :user_status, enum: -> { Telnyx::Models::Organizations::UserRetrieveResponse::Data::UserStatus }
+
+          # @!method initialize(id: nil, created_at: nil, email: nil, groups: nil, last_sign_in_at: nil, organization_user_bypasses_sso: nil, record_type: nil, user_status: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Telnyx::Models::Organizations::UserRetrieveResponse::Data} for more details.
+          #
+          #   @param id [String] Identifies the specific resource.
+          #
+          #   @param created_at [String] ISO 8601 formatted date indicating when the resource was created.
+          #
+          #   @param email [String] The email address of the user.
+          #
+          #   @param groups [Array<Telnyx::Models::Organizations::UserGroupReference>] The groups the user belongs to. Only included when include_groups parameter is t
+          #
+          #   @param last_sign_in_at [String, nil] ISO 8601 formatted date indicating when the resource last signed into the portal
+          #
+          #   @param organization_user_bypasses_sso [Boolean] Indicates whether this user is allowed to bypass SSO and use password authentica
+          #
+          #   @param record_type [String] Identifies the type of the resource. Can be 'organization_owner' or 'organizatio
+          #
+          #   @param user_status [Symbol, Telnyx::Models::Organizations::UserRetrieveResponse::Data::UserStatus] The status of the account.
+
+          # The status of the account.
+          #
+          # @see Telnyx::Models::Organizations::UserRetrieveResponse::Data#user_status
+          module UserStatus
+            extend Telnyx::Internal::Type::Enum
+
+            ENABLED = :enabled
+            DISABLED = :disabled
+            BLOCKED = :blocked
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/organizations/users/action_remove_params.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Organizations
+      module Users
+        # @see Telnyx::Resources::Organizations::Users::Actions#remove
+        class ActionRemoveParams < Telnyx::Internal::Type::BaseModel
+          extend Telnyx::Internal::Type::RequestParameters::Converter
+          include Telnyx::Internal::Type::RequestParameters
+
+          # @!method initialize(request_options: {})
+          #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/organizations/users/action_remove_response.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Organizations
+      module Users
+        # @see Telnyx::Resources::Organizations::Users::Actions#remove
+        class ActionRemoveResponse < Telnyx::Internal::Type::BaseModel
+          # @!attribute data
+          #
+          #   @return [Telnyx::Models::Organizations::Users::ActionRemoveResponse::Data, nil]
+          optional :data, -> { Telnyx::Models::Organizations::Users::ActionRemoveResponse::Data }
+
+          # @!method initialize(data: nil)
+          #   @param data [Telnyx::Models::Organizations::Users::ActionRemoveResponse::Data]
+
+          # @see Telnyx::Models::Organizations::Users::ActionRemoveResponse#data
+          class Data < Telnyx::Internal::Type::BaseModel
+            # @!attribute id
+            #   Identifies the specific resource.
+            #
+            #   @return [String, nil]
+            optional :id, String
+
+            # @!attribute created_at
+            #   ISO 8601 formatted date indicating when the resource was created.
+            #
+            #   @return [String, nil]
+            optional :created_at, String
+
+            # @!attribute email
+            #   The email address of the user.
+            #
+            #   @return [String, nil]
+            optional :email, String
+
+            # @!attribute groups
+            #   The groups the user belongs to. Only included when include_groups parameter is
+            #   true.
+            #
+            #   @return [Array<Telnyx::Models::Organizations::UserGroupReference>, nil]
+            optional :groups, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Organizations::UserGroupReference] }
+
+            # @!attribute last_sign_in_at
+            #   ISO 8601 formatted date indicating when the resource last signed into the
+            #   portal. Null if the user has never signed in.
+            #
+            #   @return [String, nil]
+            optional :last_sign_in_at, String, nil?: true
+
+            # @!attribute organization_user_bypasses_sso
+            #   Indicates whether this user is allowed to bypass SSO and use password
+            #   authentication.
+            #
+            #   @return [Boolean, nil]
+            optional :organization_user_bypasses_sso, Telnyx::Internal::Type::Boolean
+
+            # @!attribute record_type
+            #   Identifies the type of the resource. Can be 'organization_owner' or
+            #   'organization_sub_user'.
+            #
+            #   @return [String, nil]
+            optional :record_type, String
+
+            # @!attribute user_status
+            #   The status of the account.
+            #
+            #   @return [Symbol, Telnyx::Models::Organizations::Users::ActionRemoveResponse::Data::UserStatus, nil]
+            optional :user_status,
+                     enum: -> { Telnyx::Models::Organizations::Users::ActionRemoveResponse::Data::UserStatus }
+
+            # @!method initialize(id: nil, created_at: nil, email: nil, groups: nil, last_sign_in_at: nil, organization_user_bypasses_sso: nil, record_type: nil, user_status: nil)
+            #   Some parameter documentations has been truncated, see
+            #   {Telnyx::Models::Organizations::Users::ActionRemoveResponse::Data} for more
+            #   details.
+            #
+            #   @param id [String] Identifies the specific resource.
+            #
+            #   @param created_at [String] ISO 8601 formatted date indicating when the resource was created.
+            #
+            #   @param email [String] The email address of the user.
+            #
+            #   @param groups [Array<Telnyx::Models::Organizations::UserGroupReference>] The groups the user belongs to. Only included when include_groups parameter is t
+            #
+            #   @param last_sign_in_at [String, nil] ISO 8601 formatted date indicating when the resource last signed into the portal
+            #
+            #   @param organization_user_bypasses_sso [Boolean] Indicates whether this user is allowed to bypass SSO and use password authentica
+            #
+            #   @param record_type [String] Identifies the type of the resource. Can be 'organization_owner' or 'organizatio
+            #
+            #   @param user_status [Symbol, Telnyx::Models::Organizations::Users::ActionRemoveResponse::Data::UserStatus] The status of the account.
+
+            # The status of the account.
+            #
+            # @see Telnyx::Models::Organizations::Users::ActionRemoveResponse::Data#user_status
+            module UserStatus
+              extend Telnyx::Internal::Type::Enum
+
+              ENABLED = :enabled
+              DISABLED = :disabled
+              BLOCKED = :blocked
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/private_wireless_gateway_status.rb

@@ -5,7 +5,8 @@ module Telnyx
     class PrivateWirelessGatewayStatus < Telnyx::Internal::Type::BaseModel
       response_only do
         # @!attribute error_code
-        #   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.
         #
         #   @return [String, nil]
@@ -37,7 +38,7 @@ module Telnyx
       #
       #   The current status or failure details of the Private Wireless Gateway.
       #
-      #   @param error_code [String, nil] This attribute is an [error code](https://developers.telnyx.com/api/errors) rela
+      #   @param error_code [String, nil] This attribute is an [error code](https://developers.telnyx.com/development/api-
       #
       #   @param error_description [String, nil] This attribute provides a human-readable explanation of why a failure happened.
       #

data/lib/telnyx/models/queues/call_list_params.rb

@@ -15,12 +15,26 @@ module Telnyx
         #   @return [Telnyx::Models::Queues::CallListParams::Page, nil]
         optional :page, -> { Telnyx::Queues::CallListParams::Page }
 
-        # @!method initialize(page: nil, request_options: {})
+        # @!attribute page_number
+        #
+        #   @return [Integer, nil]
+        optional :page_number, Integer
+
+        # @!attribute page_size
+        #
+        #   @return [Integer, nil]
+        optional :page_size, Integer
+
+        # @!method initialize(page: nil, page_number: nil, page_size: nil, request_options: {})
         #   Some parameter documentations has been truncated, see
         #   {Telnyx::Models::Queues::CallListParams} for more details.
         #
         #   @param page [Telnyx::Models::Queues::CallListParams::Page] Consolidated page parameter (deepObject style). Originally: page[after], page[be
         #
+        #   @param page_number [Integer]
+        #
+        #   @param page_size [Integer]
+        #
         #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
 
         class Page < Telnyx::Internal::Type::BaseModel
@@ -42,19 +56,7 @@ module Telnyx
           #   @return [Integer, nil]
           optional :limit, Integer
 
-          # @!attribute number
-          #   The page number to load
-          #
-          #   @return [Integer, nil]
-          optional :number, Integer
-
-          # @!attribute size
-          #   The size of the page
-          #
-          #   @return [Integer, nil]
-          optional :size, Integer
-
-          # @!method initialize(after: nil, before: nil, limit: nil, number: nil, size: nil)
+          # @!method initialize(after: nil, before: nil, limit: nil)
           #   Consolidated page parameter (deepObject style). Originally: page[after],
           #   page[before], page[limit], page[size], page[number]
           #
@@ -63,10 +65,6 @@ module Telnyx
           #   @param before [String] Opaque identifier of previous page
           #
           #   @param limit [Integer] Limit of records per single page
-          #
-          #   @param number [Integer] The page number to load
-          #
-          #   @param size [Integer] The size of the page
         end
       end
     end