sentdm 0.19.0 → 0.20.0

data/lib/sentdm/models/template_variable.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class TemplateVariable < Sentdm::Internal::Type::BaseModel
+      # @!attribute name
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute props
+      #
+      #   @return [Sentdm::Models::TemplateVariable::Props]
+      required :props, -> { Sentdm::TemplateVariable::Props }
+
+      # @!attribute type
+      #
+      #   @return [String]
+      required :type, String
+
+      # @!attribute id
+      #
+      #   @return [Integer, nil]
+      optional :id, Integer
+
+      # @!method initialize(name:, props:, type:, id: nil)
+      #   @param name [String]
+      #   @param props [Sentdm::Models::TemplateVariable::Props]
+      #   @param type [String]
+      #   @param id [Integer]
+
+      # @see Sentdm::Models::TemplateVariable#props
+      class Props < Sentdm::Internal::Type::BaseModel
+        # @!attribute media_type
+        #
+        #   @return [String]
+        required :media_type, String, api_name: :mediaType
+
+        # @!attribute sample
+        #
+        #   @return [String]
+        required :sample, String
+
+        # @!attribute url
+        #
+        #   @return [String]
+        required :url, String
+
+        # @!attribute variable_type
+        #
+        #   @return [String]
+        required :variable_type, String, api_name: :variableType
+
+        # @!attribute alt
+        #
+        #   @return [String, nil]
+        optional :alt, String, nil?: true
+
+        # @!attribute regex
+        #
+        #   @return [String, nil]
+        optional :regex, String, nil?: true
+
+        # @!attribute short_url
+        #
+        #   @return [String, nil]
+        optional :short_url, String, api_name: :shortUrl, nil?: true
+
+        # @!method initialize(media_type:, sample:, url:, variable_type:, alt: nil, regex: nil, short_url: nil)
+        #   @param media_type [String]
+        #   @param sample [String]
+        #   @param url [String]
+        #   @param variable_type [String]
+        #   @param alt [String, nil]
+        #   @param regex [String, nil]
+        #   @param short_url [String, nil]
+      end
+    end
+  end
+end

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] List of users response
       #
-      #   @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,158 +44,13 @@ module Sentdm
         # @!attribute users
         #   List of users in the organization
         #
-        #   @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(users: nil)
         #   List of users response
         #
-        #   @param users [Array<Sentdm::Models::UserListResponse::Data::User>] List of users in the organization
-
-        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 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, email: nil, invited_at: nil, last_login_at: nil, name: nil, role: nil, status: nil, updated_at: nil)
-          #   User response for v3 API
-          #
-          #   @param id [String] User unique identifier
-          #
-          #   @param created_at [Time] When the user was added to the organization
-          #
-          #   @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>] List of users in the organization
       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,82 @@
+# 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 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, email: nil, invited_at: nil, last_login_at: nil, name: nil, role: nil, status: nil, updated_at: nil)
+      #   User response for v3 API
+      #
+      #   @param id [String] User unique identifier
+      #
+      #   @param created_at [Time] When the user was added to the organization
+      #
+      #   @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

data/lib/sentdm/models/webhook_list_event_types_response.rb

@@ -13,14 +13,14 @@ module Sentdm
       # @!attribute error
       #   Error information
       #
-      #   @return [Sentdm::Models::WebhookListEventTypesResponse::Error, nil]
-      optional :error, -> { Sentdm::Models::WebhookListEventTypesResponse::Error }, nil?: true
+      #   @return [Sentdm::Models::ErrorDetail, nil]
+      optional :error, -> { Sentdm::ErrorDetail }, nil?: true
 
       # @!attribute meta
       #   Request and response metadata
       #
-      #   @return [Sentdm::Models::WebhookListEventTypesResponse::Meta, nil]
-      optional :meta, -> { Sentdm::Models::WebhookListEventTypesResponse::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::WebhookListEventTypesResponse::Data, nil] The response data (null if error)
       #
-      #   @param error [Sentdm::Models::WebhookListEventTypesResponse::Error, nil] Error information
+      #   @param error [Sentdm::Models::ErrorDetail, nil] Error information
       #
-      #   @param meta [Sentdm::Models::WebhookListEventTypesResponse::Meta] Request and response metadata
+      #   @param meta [Sentdm::Models::APIMeta] Request and response metadata
       #
       #   @param success [Boolean] Indicates whether the request was successful
 
@@ -43,122 +43,13 @@ module Sentdm
       class Data < Sentdm::Internal::Type::BaseModel
         # @!attribute event_types
         #
-        #   @return [Array<Sentdm::Models::WebhookListEventTypesResponse::Data::EventType>, nil]
-        optional :event_types,
-                 -> { Sentdm::Internal::Type::ArrayOf[Sentdm::Models::WebhookListEventTypesResponse::Data::EventType] }
+        #   @return [Array<Sentdm::Models::WebhookEventType>, nil]
+        optional :event_types, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::WebhookEventType] }
 
         # @!method initialize(event_types: nil)
         #   The response data (null if error)
         #
-        #   @param event_types [Array<Sentdm::Models::WebhookListEventTypesResponse::Data::EventType>]
-
-        class EventType < 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<Object>, nil]
-          optional :sub_types, Sentdm::Internal::Type::ArrayOf[Sentdm::Internal::Type::Unknown], 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<Object>, nil]
-        end
-      end
-
-      # @see Sentdm::Models::WebhookListEventTypesResponse#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::WebhookListEventTypesResponse#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 event_types [Array<Sentdm::Models::WebhookEventType>]
       end
     end
   end