sentdm 0.29.0 → 0.31.0

data/lib/sentdm/models/user_list_response.rb

@@ -13,14 +13,14 @@ module Sentdm
       # @!attribute error
       #   Error information
       #
-      #   @return [Sentdm::Models::UserListResponse::Error, nil]
-      optional :error, -> { Sentdm::Models::UserListResponse::Error }, nil?: true
+      #   @return [Sentdm::Models::ErrorDetail, nil]
+      optional :error, -> { Sentdm::ErrorDetail }, nil?: true
 
       # @!attribute meta
       #   Request and response metadata
       #
-      #   @return [Sentdm::Models::UserListResponse::Meta, nil]
-      optional :meta, -> { Sentdm::Models::UserListResponse::Meta }
+      #   @return [Sentdm::Models::APIMeta, nil]
+      optional :meta, -> { Sentdm::APIMeta }
 
       # @!attribute success
       #   Indicates whether the request was successful
@@ -33,9 +33,9 @@ module Sentdm
       #
       #   @param data [Sentdm::Models::UserListResponse::Data, nil] The users in the organization.
       #
-      #   @param error [Sentdm::Models::UserListResponse::Error, nil] Error information
+      #   @param error [Sentdm::Models::ErrorDetail, nil] Error information
       #
-      #   @param meta [Sentdm::Models::UserListResponse::Meta] Request and response metadata
+      #   @param meta [Sentdm::Models::APIMeta] Request and response metadata
       #
       #   @param success [Boolean] Indicates whether the request was successful
 
@@ -44,258 +44,21 @@ module Sentdm
         # @!attribute pagination
         #   Pagination metadata for list responses
         #
-        #   @return [Sentdm::Models::UserListResponse::Data::Pagination, nil]
-        optional :pagination, -> { Sentdm::Models::UserListResponse::Data::Pagination }
+        #   @return [Sentdm::Models::PaginationMeta, nil]
+        optional :pagination, -> { Sentdm::PaginationMeta }
 
         # @!attribute users
         #   The users on this page.
         #
-        #   @return [Array<Sentdm::Models::UserListResponse::Data::User>, nil]
-        optional :users, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::Models::UserListResponse::Data::User] }
+        #   @return [Array<Sentdm::Models::UserResponse>, nil]
+        optional :users, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::UserResponse] }
 
         # @!method initialize(pagination: nil, users: nil)
         #   The users in the organization.
         #
-        #   @param pagination [Sentdm::Models::UserListResponse::Data::Pagination] Pagination metadata for list responses
+        #   @param pagination [Sentdm::Models::PaginationMeta] Pagination metadata for list responses
         #
-        #   @param users [Array<Sentdm::Models::UserListResponse::Data::User>] The users on this page.
-
-        # @see Sentdm::Models::UserListResponse::Data#pagination
-        class Pagination < Sentdm::Internal::Type::BaseModel
-          # @!attribute cursors
-          #   @deprecated
-          #
-          #   Cursor-based pagination. Never populated — see Cursors.
-          #
-          #   @return [Sentdm::Models::UserListResponse::Data::Pagination::Cursors, nil]
-          optional :cursors, -> { Sentdm::Models::UserListResponse::Data::Pagination::Cursors }, nil?: true
-
-          # @!attribute has_more
-          #   Whether there are more pages after this one
-          #
-          #   @return [Boolean, nil]
-          optional :has_more, Sentdm::Internal::Type::Boolean
-
-          # @!attribute page
-          #   Current page number (1-indexed)
-          #
-          #   @return [Integer, nil]
-          optional :page, Integer
-
-          # @!attribute page_size
-          #   Number of items per page
-          #
-          #   @return [Integer, nil]
-          optional :page_size, Integer
-
-          # @!attribute total_count
-          #   Total number of items across all pages
-          #
-          #   @return [Integer, nil]
-          optional :total_count, Integer
-
-          # @!attribute total_pages
-          #   Total number of pages
-          #
-          #   @return [Integer, nil]
-          optional :total_pages, Integer
-
-          # @!method initialize(cursors: nil, has_more: nil, page: nil, page_size: nil, total_count: nil, total_pages: nil)
-          #   Pagination metadata for list responses
-          #
-          #   @param cursors [Sentdm::Models::UserListResponse::Data::Pagination::Cursors, nil] Cursor-based pagination. Never populated — see Cursors.
-          #
-          #   @param has_more [Boolean] Whether there are more pages after this one
-          #
-          #   @param page [Integer] Current page number (1-indexed)
-          #
-          #   @param page_size [Integer] Number of items per page
-          #
-          #   @param total_count [Integer] Total number of items across all pages
-          #
-          #   @param total_pages [Integer] Total number of pages
-
-          # @deprecated
-          #
-          # @see Sentdm::Models::UserListResponse::Data::Pagination#cursors
-          class Cursors < Sentdm::Internal::Type::BaseModel
-            # @!attribute after
-            #   Cursor to fetch the next page.
-            #
-            #   @return [String, nil]
-            optional :after, String, nil?: true
-
-            # @!attribute before
-            #   Cursor to fetch the previous page.
-            #
-            #   @return [String, nil]
-            optional :before, String, nil?: true
-
-            # @!method initialize(after: nil, before: nil)
-            #   Cursor-based pagination. Never populated — see Cursors.
-            #
-            #   @param after [String, nil] Cursor to fetch the next page.
-            #
-            #   @param before [String, nil] Cursor to fetch the previous page.
-          end
-        end
-
-        class User < Sentdm::Internal::Type::BaseModel
-          # @!attribute id
-          #   User unique identifier
-          #
-          #   @return [String, nil]
-          optional :id, String
-
-          # @!attribute created_at
-          #   When the user was added to the organization
-          #
-          #   @return [Time, nil]
-          optional :created_at, Time
-
-          # @!attribute customer_id
-          #   Which customer owns this — the key's own, or the profile named in x-profile-id.
-          #   Says whose resource this is, which the resource's own id does not.
-          #
-          #   @return [String, nil]
-          optional :customer_id, String
-
-          # @!attribute email
-          #   User email address
-          #
-          #   @return [String, nil]
-          optional :email, String
-
-          # @!attribute invited_at
-          #   When the user was invited
-          #
-          #   @return [Time, nil]
-          optional :invited_at, Time, nil?: true
-
-          # @!attribute last_login_at
-          #   When the user last logged in
-          #
-          #   @return [Time, nil]
-          optional :last_login_at, Time, nil?: true
-
-          # @!attribute name
-          #   User full name
-          #
-          #   @return [String, nil]
-          optional :name, String
-
-          # @!attribute role
-          #   User role in the organization: admin, billing, developer
-          #
-          #   @return [String, nil]
-          optional :role, String
-
-          # @!attribute status
-          #   User status: active, invited, suspended, rejected
-          #
-          #   @return [String, nil]
-          optional :status, String
-
-          # @!attribute updated_at
-          #   When the user record was last updated
-          #
-          #   @return [Time, nil]
-          optional :updated_at, Time, nil?: true
-
-          # @!method initialize(id: nil, created_at: nil, customer_id: nil, email: nil, invited_at: nil, last_login_at: nil, name: nil, role: nil, status: nil, updated_at: nil)
-          #   Some parameter documentations has been truncated, see
-          #   {Sentdm::Models::UserListResponse::Data::User} for more details.
-          #
-          #   User response for v3 API
-          #
-          #   @param id [String] User unique identifier
-          #
-          #   @param created_at [Time] When the user was added to the organization
-          #
-          #   @param customer_id [String] Which customer owns this — the key's own, or the profile named in x-profile-id.
-          #
-          #   @param email [String] User email address
-          #
-          #   @param invited_at [Time, nil] When the user was invited
-          #
-          #   @param last_login_at [Time, nil] When the user last logged in
-          #
-          #   @param name [String] User full name
-          #
-          #   @param role [String] User role in the organization: admin, billing, developer
-          #
-          #   @param status [String] User status: active, invited, suspended, rejected
-          #
-          #   @param updated_at [Time, nil] When the user record was last updated
-        end
-      end
-
-      # @see Sentdm::Models::UserListResponse#error
-      class Error < Sentdm::Internal::Type::BaseModel
-        # @!attribute code
-        #   Machine-readable error code (e.g., "RESOURCE_001")
-        #
-        #   @return [String, nil]
-        optional :code, String
-
-        # @!attribute details
-        #   Additional validation error details (field-level errors)
-        #
-        #   @return [Hash{Symbol=>Array<String>}, nil]
-        optional :details, Sentdm::Internal::Type::HashOf[Sentdm::Internal::Type::ArrayOf[String]], nil?: true
-
-        # @!attribute doc_url
-        #   URL to documentation about this error
-        #
-        #   @return [String, nil]
-        optional :doc_url, String, nil?: true
-
-        # @!attribute message
-        #   Human-readable error message
-        #
-        #   @return [String, nil]
-        optional :message, String
-
-        # @!method initialize(code: nil, details: nil, doc_url: nil, message: nil)
-        #   Error information
-        #
-        #   @param code [String] Machine-readable error code (e.g., "RESOURCE_001")
-        #
-        #   @param details [Hash{Symbol=>Array<String>}, nil] Additional validation error details (field-level errors)
-        #
-        #   @param doc_url [String, nil] URL to documentation about this error
-        #
-        #   @param message [String] Human-readable error message
-      end
-
-      # @see Sentdm::Models::UserListResponse#meta
-      class Meta < Sentdm::Internal::Type::BaseModel
-        # @!attribute request_id
-        #   Unique identifier for this request (for tracing and support)
-        #
-        #   @return [String, nil]
-        optional :request_id, String
-
-        # @!attribute timestamp
-        #   Server timestamp when the response was generated
-        #
-        #   @return [Time, nil]
-        optional :timestamp, Time
-
-        # @!attribute version
-        #   API version used for this request
-        #
-        #   @return [String, nil]
-        optional :version, String
-
-        # @!method initialize(request_id: nil, timestamp: nil, version: nil)
-        #   Request and response metadata
-        #
-        #   @param request_id [String] Unique identifier for this request (for tracing and support)
-        #
-        #   @param timestamp [Time] Server timestamp when the response was generated
-        #
-        #   @param version [String] API version used for this request
+        #   @param users [Array<Sentdm::Models::UserResponse>] The users on this page.
       end
     end
   end

data/lib/sentdm/models/user_remove_params.rb

@@ -3,7 +3,7 @@
 module Sentdm
   module Models
     # @see Sentdm::Resources::Users#remove
-    class UserRemoveParams < Sentdm::Internal::Type::BaseModel
+    class UserRemoveParams < Sentdm::Models::MutationRequest
       extend Sentdm::Internal::Type::RequestParameters::Converter
       include Sentdm::Internal::Type::RequestParameters
 
@@ -12,28 +12,14 @@ module Sentdm
       #   @return [String]
       required :user_id, String
 
-      # @!attribute sandbox
-      #   Sandbox flag - when true, the operation is simulated without side effects Useful
-      #   for testing integrations without actual execution
-      #
-      #   @return [Boolean, nil]
-      optional :sandbox, Sentdm::Internal::Type::Boolean
-
       # @!attribute x_profile_id
       #
       #   @return [String, nil]
       optional :x_profile_id, String
 
-      # @!method initialize(user_id:, sandbox: nil, x_profile_id: nil, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {Sentdm::Models::UserRemoveParams} for more details.
-      #
+      # @!method initialize(user_id:, x_profile_id: nil, request_options: {})
       #   @param user_id [String]
-      #
-      #   @param sandbox [Boolean] Sandbox flag - when true, the operation is simulated without side effects
-      #
       #   @param x_profile_id [String]
-      #
       #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/sentdm/models/user_response.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class UserResponse < Sentdm::Internal::Type::BaseModel
+      # @!attribute id
+      #   User unique identifier
+      #
+      #   @return [String, nil]
+      optional :id, String
+
+      # @!attribute created_at
+      #   When the user was added to the organization
+      #
+      #   @return [Time, nil]
+      optional :created_at, Time
+
+      # @!attribute customer_id
+      #   Which customer owns this — the key's own, or the profile named in x-profile-id.
+      #   Says whose resource this is, which the resource's own id does not.
+      #
+      #   @return [String, nil]
+      optional :customer_id, String
+
+      # @!attribute email
+      #   User email address
+      #
+      #   @return [String, nil]
+      optional :email, String
+
+      # @!attribute invited_at
+      #   When the user was invited
+      #
+      #   @return [Time, nil]
+      optional :invited_at, Time, nil?: true
+
+      # @!attribute last_login_at
+      #   When the user last logged in
+      #
+      #   @return [Time, nil]
+      optional :last_login_at, Time, nil?: true
+
+      # @!attribute name
+      #   User full name
+      #
+      #   @return [String, nil]
+      optional :name, String
+
+      # @!attribute role
+      #   User role in the organization: admin, billing, developer
+      #
+      #   @return [String, nil]
+      optional :role, String
+
+      # @!attribute status
+      #   User status: active, invited, suspended, rejected
+      #
+      #   @return [String, nil]
+      optional :status, String
+
+      # @!attribute updated_at
+      #   When the user record was last updated
+      #
+      #   @return [Time, nil]
+      optional :updated_at, Time, nil?: true
+
+      # @!method initialize(id: nil, created_at: nil, customer_id: nil, email: nil, invited_at: nil, last_login_at: nil, name: nil, role: nil, status: nil, updated_at: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Sentdm::Models::UserResponse} for more details.
+      #
+      #   User response for v3 API
+      #
+      #   @param id [String] User unique identifier
+      #
+      #   @param created_at [Time] When the user was added to the organization
+      #
+      #   @param customer_id [String] Which customer owns this — the key's own, or the profile named in x-profile-id.
+      #
+      #   @param email [String] User email address
+      #
+      #   @param invited_at [Time, nil] When the user was invited
+      #
+      #   @param last_login_at [Time, nil] When the user last logged in
+      #
+      #   @param name [String] User full name
+      #
+      #   @param role [String] User role in the organization: admin, billing, developer
+      #
+      #   @param status [String] User status: active, invited, suspended, rejected
+      #
+      #   @param updated_at [Time, nil] When the user record was last updated
+    end
+  end
+end

data/lib/sentdm/models/webhook_event_type.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class WebhookEventType < Sentdm::Internal::Type::BaseModel
+      # @!attribute description
+      #
+      #   @return [String, nil]
+      optional :description, String, nil?: true
+
+      # @!attribute display_name
+      #
+      #   @return [String, nil]
+      optional :display_name, String
+
+      # @!attribute event_type
+      #
+      #   @return [String, nil]
+      optional :event_type, String, nil?: true
+
+      # @!attribute is_active
+      #
+      #   @return [Boolean, nil]
+      optional :is_active, Sentdm::Internal::Type::Boolean
+
+      # @!attribute name
+      #
+      #   @return [String, nil]
+      optional :name, String
+
+      # @!attribute sub_types
+      #
+      #   @return [Array<Sentdm::Models::WebhookEventType>, nil]
+      optional :sub_types, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::WebhookEventType] }, nil?: true
+
+      # @!method initialize(description: nil, display_name: nil, event_type: nil, is_active: nil, name: nil, sub_types: nil)
+      #   @param description [String, nil]
+      #   @param display_name [String]
+      #   @param event_type [String, nil]
+      #   @param is_active [Boolean]
+      #   @param name [String]
+      #   @param sub_types [Array<Sentdm::Models::WebhookEventType>, nil]
+    end
+  end
+end