sentdm 0.2.0 → 0.3.1

data/lib/sentdm/models/user_list_response.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    # @see Sentdm::Resources::Users#list
+    class UserListResponse < Sentdm::Internal::Type::BaseModel
+      # @!attribute data
+      #   The response data (null if error)
+      #
+      #   @return [Sentdm::Models::UserListResponse::Data, nil]
+      optional :data, -> { Sentdm::Models::UserListResponse::Data }, nil?: true
+
+      # @!attribute error
+      #   Error details (null if successful)
+      #
+      #   @return [Sentdm::Models::APIError, nil]
+      optional :error, -> { Sentdm::APIError }, nil?: true
+
+      # @!attribute meta
+      #   Metadata about the request and response
+      #
+      #   @return [Sentdm::Models::APIMeta, nil]
+      optional :meta, -> { Sentdm::APIMeta }
+
+      # @!attribute success
+      #   Indicates whether the request was successful
+      #
+      #   @return [Boolean, nil]
+      optional :success, Sentdm::Internal::Type::Boolean
+
+      # @!method initialize(data: nil, error: nil, meta: nil, success: nil)
+      #   Standard API response envelope for all v3 endpoints
+      #
+      #   @param data [Sentdm::Models::UserListResponse::Data, nil] The response data (null if error)
+      #
+      #   @param error [Sentdm::Models::APIError, nil] Error details (null if successful)
+      #
+      #   @param meta [Sentdm::Models::APIMeta] Metadata about the request and response
+      #
+      #   @param success [Boolean] Indicates whether the request was successful
+
+      # @see Sentdm::Models::UserListResponse#data
+      class Data < Sentdm::Internal::Type::BaseModel
+        # @!attribute users
+        #   List of users in the organization
+        #
+        #   @return [Array<Sentdm::Models::UserResponse>, nil]
+        optional :users, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::UserResponse] }
+
+        # @!method initialize(users: nil)
+        #   The response data (null if error)
+        #
+        #   @param users [Array<Sentdm::Models::UserResponse>] List of users in the organization
+      end
+    end
+  end
+end

data/lib/sentdm/models/user_remove_params.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    # @see Sentdm::Resources::Users#remove
+    class UserRemoveParams < Sentdm::Internal::Type::BaseModel
+      extend Sentdm::Internal::Type::RequestParameters::Converter
+      include Sentdm::Internal::Type::RequestParameters
+
+      # @!attribute path_user_id
+      #
+      #   @return [String]
+      required :path_user_id, String
+
+      # @!attribute test_mode
+      #   Test mode flag - when true, the operation is simulated without side effects
+      #   Useful for testing integrations without actual execution
+      #
+      #   @return [Boolean, nil]
+      optional :test_mode, Sentdm::Internal::Type::Boolean
+
+      # @!attribute body_user_id
+      #   User ID from route parameter
+      #
+      #   @return [String, nil]
+      optional :body_user_id, String, api_name: :user_id
+
+      # @!method initialize(path_user_id:, test_mode: nil, body_user_id: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Sentdm::Models::UserRemoveParams} for more details.
+      #
+      #   @param path_user_id [String]
+      #
+      #   @param test_mode [Boolean] Test mode flag - when true, the operation is simulated without side effects
+      #
+      #   @param body_user_id [String] User ID from route parameter
+      #
+      #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
+    end
+  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/user_retrieve_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    # @see Sentdm::Resources::Users#retrieve
+    class UserRetrieveParams < Sentdm::Internal::Type::BaseModel
+      extend Sentdm::Internal::Type::RequestParameters::Converter
+      include Sentdm::Internal::Type::RequestParameters
+
+      # @!attribute user_id
+      #
+      #   @return [String]
+      required :user_id, String
+
+      # @!method initialize(user_id:, request_options: {})
+      #   @param user_id [String]
+      #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/sentdm/models/user_update_role_params.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    # @see Sentdm::Resources::Users#update_role
+    class UserUpdateRoleParams < Sentdm::Internal::Type::BaseModel
+      extend Sentdm::Internal::Type::RequestParameters::Converter
+      include Sentdm::Internal::Type::RequestParameters
+
+      # @!attribute path_user_id
+      #
+      #   @return [String]
+      required :path_user_id, String
+
+      # @!attribute role
+      #   User role: admin, billing, or developer (required)
+      #
+      #   @return [String, nil]
+      optional :role, String
+
+      # @!attribute test_mode
+      #   Test mode flag - when true, the operation is simulated without side effects
+      #   Useful for testing integrations without actual execution
+      #
+      #   @return [Boolean, nil]
+      optional :test_mode, Sentdm::Internal::Type::Boolean
+
+      # @!attribute body_user_id
+      #   User ID from route parameter
+      #
+      #   @return [String, nil]
+      optional :body_user_id, String, api_name: :user_id
+
+      # @!attribute idempotency_key
+      #
+      #   @return [String, nil]
+      optional :idempotency_key, String
+
+      # @!method initialize(path_user_id:, role: nil, test_mode: nil, body_user_id: nil, idempotency_key: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Sentdm::Models::UserUpdateRoleParams} for more details.
+      #
+      #   @param path_user_id [String]
+      #
+      #   @param role [String] User role: admin, billing, or developer (required)
+      #
+      #   @param test_mode [Boolean] Test mode flag - when true, the operation is simulated without side effects
+      #
+      #   @param body_user_id [String] User ID from route parameter
+      #
+      #   @param idempotency_key [String]
+      #
+      #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/sentdm/models/webhook_create_params.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    # @see Sentdm::Resources::Webhooks#create
+    class WebhookCreateParams < Sentdm::Internal::Type::BaseModel
+      extend Sentdm::Internal::Type::RequestParameters::Converter
+      include Sentdm::Internal::Type::RequestParameters
+
+      # @!attribute display_name
+      #
+      #   @return [String, nil]
+      optional :display_name, String
+
+      # @!attribute endpoint_url
+      #
+      #   @return [String, nil]
+      optional :endpoint_url, String
+
+      # @!attribute event_types
+      #
+      #   @return [Array<String>, nil]
+      optional :event_types, Sentdm::Internal::Type::ArrayOf[String]
+
+      # @!attribute retry_count
+      #
+      #   @return [Integer, nil]
+      optional :retry_count, Integer
+
+      # @!attribute test_mode
+      #   Test mode flag - when true, the operation is simulated without side effects
+      #   Useful for testing integrations without actual execution
+      #
+      #   @return [Boolean, nil]
+      optional :test_mode, Sentdm::Internal::Type::Boolean
+
+      # @!attribute timeout_seconds
+      #
+      #   @return [Integer, nil]
+      optional :timeout_seconds, Integer
+
+      # @!attribute idempotency_key
+      #
+      #   @return [String, nil]
+      optional :idempotency_key, String
+
+      # @!method initialize(display_name: nil, endpoint_url: nil, event_types: nil, retry_count: nil, test_mode: nil, timeout_seconds: nil, idempotency_key: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Sentdm::Models::WebhookCreateParams} for more details.
+      #
+      #   @param display_name [String]
+      #
+      #   @param endpoint_url [String]
+      #
+      #   @param event_types [Array<String>]
+      #
+      #   @param retry_count [Integer]
+      #
+      #   @param test_mode [Boolean] Test mode flag - when true, the operation is simulated without side effects
+      #
+      #   @param timeout_seconds [Integer]
+      #
+      #   @param idempotency_key [String]
+      #
+      #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/sentdm/models/webhook_delete_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    # @see Sentdm::Resources::Webhooks#delete
+    class WebhookDeleteParams < Sentdm::Internal::Type::BaseModel
+      extend Sentdm::Internal::Type::RequestParameters::Converter
+      include Sentdm::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!method initialize(id:, request_options: {})
+      #   @param id [String]
+      #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/sentdm/models/webhook_list_event_types_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    # @see Sentdm::Resources::Webhooks#list_event_types
+    class WebhookListEventTypesParams < Sentdm::Internal::Type::BaseModel
+      extend Sentdm::Internal::Type::RequestParameters::Converter
+      include Sentdm::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/sentdm/models/webhook_list_event_types_response.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    # @see Sentdm::Resources::Webhooks#list_event_types
+    class WebhookListEventTypesResponse < Sentdm::Internal::Type::BaseModel
+      # @!attribute data
+      #   The response data (null if error)
+      #
+      #   @return [Sentdm::Models::WebhookListEventTypesResponse::Data, nil]
+      optional :data, -> { Sentdm::Models::WebhookListEventTypesResponse::Data }, nil?: true
+
+      # @!attribute error
+      #   Error details (null if successful)
+      #
+      #   @return [Sentdm::Models::APIError, nil]
+      optional :error, -> { Sentdm::APIError }, nil?: true
+
+      # @!attribute meta
+      #   Metadata about the request and response
+      #
+      #   @return [Sentdm::Models::APIMeta, nil]
+      optional :meta, -> { Sentdm::APIMeta }
+
+      # @!attribute success
+      #   Indicates whether the request was successful
+      #
+      #   @return [Boolean, nil]
+      optional :success, Sentdm::Internal::Type::Boolean
+
+      # @!method initialize(data: nil, error: nil, meta: nil, success: nil)
+      #   Standard API response envelope for all v3 endpoints
+      #
+      #   @param data [Sentdm::Models::WebhookListEventTypesResponse::Data, nil] The response data (null if error)
+      #
+      #   @param error [Sentdm::Models::APIError, nil] Error details (null if successful)
+      #
+      #   @param meta [Sentdm::Models::APIMeta] Metadata about the request and response
+      #
+      #   @param success [Boolean] Indicates whether the request was successful
+
+      # @see Sentdm::Models::WebhookListEventTypesResponse#data
+      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] }
+
+        # @!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 is_active
+          #
+          #   @return [Boolean, nil]
+          optional :is_active, Sentdm::Internal::Type::Boolean
+
+          # @!attribute name
+          #
+          #   @return [String, nil]
+          optional :name, String
+
+          # @!method initialize(description: nil, display_name: nil, is_active: nil, name: nil)
+          #   @param description [String, nil]
+          #   @param display_name [String]
+          #   @param is_active [Boolean]
+          #   @param name [String]
+        end
+      end
+    end
+  end
+end

data/lib/sentdm/models/webhook_list_events_params.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    # @see Sentdm::Resources::Webhooks#list_events
+    class WebhookListEventsParams < Sentdm::Internal::Type::BaseModel
+      extend Sentdm::Internal::Type::RequestParameters::Converter
+      include Sentdm::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute page
+      #
+      #   @return [Integer]
+      required :page, Integer
+
+      # @!attribute page_size
+      #
+      #   @return [Integer]
+      required :page_size, Integer
+
+      # @!attribute search
+      #
+      #   @return [String, nil]
+      optional :search, String, nil?: true
+
+      # @!method initialize(id:, page:, page_size:, search: nil, request_options: {})
+      #   @param id [String]
+      #   @param page [Integer]
+      #   @param page_size [Integer]
+      #   @param search [String, nil]
+      #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/sentdm/models/webhook_list_events_response.rb

@@ -0,0 +1,135 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    # @see Sentdm::Resources::Webhooks#list_events
+    class WebhookListEventsResponse < Sentdm::Internal::Type::BaseModel
+      # @!attribute data
+      #   The response data (null if error)
+      #
+      #   @return [Sentdm::Models::WebhookListEventsResponse::Data, nil]
+      optional :data, -> { Sentdm::Models::WebhookListEventsResponse::Data }, nil?: true
+
+      # @!attribute error
+      #   Error details (null if successful)
+      #
+      #   @return [Sentdm::Models::APIError, nil]
+      optional :error, -> { Sentdm::APIError }, nil?: true
+
+      # @!attribute meta
+      #   Metadata about the request and response
+      #
+      #   @return [Sentdm::Models::APIMeta, nil]
+      optional :meta, -> { Sentdm::APIMeta }
+
+      # @!attribute success
+      #   Indicates whether the request was successful
+      #
+      #   @return [Boolean, nil]
+      optional :success, Sentdm::Internal::Type::Boolean
+
+      # @!method initialize(data: nil, error: nil, meta: nil, success: nil)
+      #   Standard API response envelope for all v3 endpoints
+      #
+      #   @param data [Sentdm::Models::WebhookListEventsResponse::Data, nil] The response data (null if error)
+      #
+      #   @param error [Sentdm::Models::APIError, nil] Error details (null if successful)
+      #
+      #   @param meta [Sentdm::Models::APIMeta] Metadata about the request and response
+      #
+      #   @param success [Boolean] Indicates whether the request was successful
+
+      # @see Sentdm::Models::WebhookListEventsResponse#data
+      class Data < Sentdm::Internal::Type::BaseModel
+        # @!attribute events
+        #
+        #   @return [Array<Sentdm::Models::WebhookListEventsResponse::Data::Event>, nil]
+        optional :events,
+                 -> { Sentdm::Internal::Type::ArrayOf[Sentdm::Models::WebhookListEventsResponse::Data::Event] }
+
+        # @!attribute pagination
+        #   Pagination metadata for list responses
+        #
+        #   @return [Sentdm::Models::PaginationMeta, nil]
+        optional :pagination, -> { Sentdm::PaginationMeta }
+
+        # @!method initialize(events: nil, pagination: nil)
+        #   The response data (null if error)
+        #
+        #   @param events [Array<Sentdm::Models::WebhookListEventsResponse::Data::Event>]
+        #
+        #   @param pagination [Sentdm::Models::PaginationMeta] Pagination metadata for list responses
+
+        class Event < Sentdm::Internal::Type::BaseModel
+          # @!attribute id
+          #
+          #   @return [String, nil]
+          optional :id, String
+
+          # @!attribute created_at
+          #
+          #   @return [Time, nil]
+          optional :created_at, Time
+
+          # @!attribute delivery_attempts
+          #
+          #   @return [Integer, nil]
+          optional :delivery_attempts, Integer
+
+          # @!attribute delivery_status
+          #
+          #   @return [String, nil]
+          optional :delivery_status, String
+
+          # @!attribute error_message
+          #
+          #   @return [String, nil]
+          optional :error_message, String, nil?: true
+
+          # @!attribute event_data
+          #
+          #   @return [Object, nil]
+          optional :event_data, Sentdm::Internal::Type::Unknown
+
+          # @!attribute event_type
+          #
+          #   @return [String, nil]
+          optional :event_type, String
+
+          # @!attribute http_status_code
+          #
+          #   @return [Integer, nil]
+          optional :http_status_code, Integer, nil?: true
+
+          # @!attribute processing_completed_at
+          #
+          #   @return [Time, nil]
+          optional :processing_completed_at, Time, nil?: true
+
+          # @!attribute processing_started_at
+          #
+          #   @return [Time, nil]
+          optional :processing_started_at, Time, nil?: true
+
+          # @!attribute response_body
+          #
+          #   @return [String, nil]
+          optional :response_body, String, nil?: true
+
+          # @!method initialize(id: nil, created_at: nil, delivery_attempts: nil, delivery_status: nil, error_message: nil, event_data: nil, event_type: nil, http_status_code: nil, processing_completed_at: nil, processing_started_at: nil, response_body: nil)
+          #   @param id [String]
+          #   @param created_at [Time]
+          #   @param delivery_attempts [Integer]
+          #   @param delivery_status [String]
+          #   @param error_message [String, nil]
+          #   @param event_data [Object]
+          #   @param event_type [String]
+          #   @param http_status_code [Integer, nil]
+          #   @param processing_completed_at [Time, nil]
+          #   @param processing_started_at [Time, nil]
+          #   @param response_body [String, nil]
+        end
+      end
+    end
+  end
+end

data/lib/sentdm/models/webhook_list_params.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    # @see Sentdm::Resources::Webhooks#list
+    class WebhookListParams < Sentdm::Internal::Type::BaseModel
+      extend Sentdm::Internal::Type::RequestParameters::Converter
+      include Sentdm::Internal::Type::RequestParameters
+
+      # @!attribute page
+      #
+      #   @return [Integer]
+      required :page, Integer
+
+      # @!attribute page_size
+      #
+      #   @return [Integer]
+      required :page_size, Integer
+
+      # @!attribute is_active
+      #
+      #   @return [Boolean, nil]
+      optional :is_active, Sentdm::Internal::Type::Boolean, nil?: true
+
+      # @!attribute search
+      #
+      #   @return [String, nil]
+      optional :search, String, nil?: true
+
+      # @!method initialize(page:, page_size:, is_active: nil, search: nil, request_options: {})
+      #   @param page [Integer]
+      #   @param page_size [Integer]
+      #   @param is_active [Boolean, nil]
+      #   @param search [String, nil]
+      #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end