sentdm 0.1.0 → 0.3.0

data/lib/sentdm/models/contact_update_params.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    # @see Sentdm::Resources::Contacts#update
+    class ContactUpdateParams < Sentdm::Internal::Type::BaseModel
+      extend Sentdm::Internal::Type::RequestParameters::Converter
+      include Sentdm::Internal::Type::RequestParameters
+
+      # @!attribute default_channel
+      #   Default messaging channel: "sms" or "whatsapp"
+      #
+      #   @return [String, nil]
+      optional :default_channel, String, nil?: true
+
+      # @!attribute opt_out
+      #   Whether the contact has opted out of messaging
+      #
+      #   @return [Boolean, nil]
+      optional :opt_out, Sentdm::Internal::Type::Boolean, nil?: true
+
+      # @!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 idempotency_key
+      #
+      #   @return [String, nil]
+      optional :idempotency_key, String
+
+      # @!method initialize(default_channel: nil, opt_out: nil, test_mode: nil, idempotency_key: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Sentdm::Models::ContactUpdateParams} for more details.
+      #
+      #   @param default_channel [String, nil] Default messaging channel: "sms" or "whatsapp"
+      #
+      #   @param opt_out [Boolean, nil] Whether the contact has opted out of messaging
+      #
+      #   @param test_mode [Boolean] Test mode flag - when true, the operation is simulated without side effects
+      #
+      #   @param idempotency_key [String]
+      #
+      #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/sentdm/models/destination_country.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class DestinationCountry < Sentdm::Internal::Type::BaseModel
+      # @!attribute id
+      #
+      #   @return [String, nil]
+      optional :id, String
+
+      # @!attribute is_main
+      #
+      #   @return [Boolean, nil]
+      optional :is_main, Sentdm::Internal::Type::Boolean, api_name: :isMain
+
+      # @!method initialize(id: nil, is_main: nil)
+      #   @param id [String]
+      #   @param is_main [Boolean]
+    end
+  end
+end

data/lib/sentdm/models/lookup_retrieve_phone_info_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    # @see Sentdm::Resources::Lookup#retrieve_phone_info
+    class LookupRetrievePhoneInfoParams < 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/lookup_retrieve_phone_info_response.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    # @see Sentdm::Resources::Lookup#retrieve_phone_info
+    class LookupRetrievePhoneInfoResponse < Sentdm::Internal::Type::BaseModel
+      # @!attribute data
+      #   The response data (null if error)
+      #
+      #   @return [Sentdm::Models::LookupRetrievePhoneInfoResponse::Data, nil]
+      optional :data, -> { Sentdm::Models::LookupRetrievePhoneInfoResponse::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::LookupRetrievePhoneInfoResponse::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::LookupRetrievePhoneInfoResponse#data
+      class Data < Sentdm::Internal::Type::BaseModel
+        # @!attribute carrier_name
+        #
+        #   @return [String, nil]
+        optional :carrier_name, String, api_name: :carrierName, nil?: true
+
+        # @!attribute is_ported
+        #
+        #   @return [Boolean, nil]
+        optional :is_ported, Sentdm::Internal::Type::Boolean, api_name: :isPorted, nil?: true
+
+        # @!attribute is_valid
+        #
+        #   @return [Boolean, nil]
+        optional :is_valid, Sentdm::Internal::Type::Boolean, api_name: :isValid
+
+        # @!attribute is_voip
+        #
+        #   @return [Boolean, nil]
+        optional :is_voip, Sentdm::Internal::Type::Boolean, api_name: :isVoip, nil?: true
+
+        # @!attribute line_type
+        #
+        #   @return [String, nil]
+        optional :line_type, String, api_name: :lineType, nil?: true
+
+        # @!attribute mobile_country_code
+        #
+        #   @return [String, nil]
+        optional :mobile_country_code, String, api_name: :mobileCountryCode, nil?: true
+
+        # @!attribute mobile_network_code
+        #
+        #   @return [String, nil]
+        optional :mobile_network_code, String, api_name: :mobileNetworkCode, nil?: true
+
+        # @!attribute phone_number
+        #
+        #   @return [String, nil]
+        optional :phone_number, String, api_name: :phoneNumber
+
+        # @!attribute provider
+        #
+        #   @return [String, nil]
+        optional :provider, String
+
+        # @!method initialize(carrier_name: nil, is_ported: nil, is_valid: nil, is_voip: nil, line_type: nil, mobile_country_code: nil, mobile_network_code: nil, phone_number: nil, provider: nil)
+        #   The response data (null if error)
+        #
+        #   @param carrier_name [String, nil]
+        #   @param is_ported [Boolean, nil]
+        #   @param is_valid [Boolean]
+        #   @param is_voip [Boolean, nil]
+        #   @param line_type [String, nil]
+        #   @param mobile_country_code [String, nil]
+        #   @param mobile_network_code [String, nil]
+        #   @param phone_number [String]
+        #   @param provider [String]
+      end
+    end
+  end
+end

data/lib/sentdm/models/me_retrieve_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    # @see Sentdm::Resources::Me#retrieve
+    class MeRetrieveParams < 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/me_retrieve_response.rb

@@ -0,0 +1,200 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    # @see Sentdm::Resources::Me#retrieve
+    class MeRetrieveResponse < Sentdm::Internal::Type::BaseModel
+      # @!attribute data
+      #   The response data (null if error)
+      #
+      #   @return [Sentdm::Models::MeRetrieveResponse::Data, nil]
+      optional :data, -> { Sentdm::Models::MeRetrieveResponse::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::MeRetrieveResponse::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::MeRetrieveResponse#data
+      class Data < Sentdm::Internal::Type::BaseModel
+        # @!attribute id
+        #   Customer ID (organization or profile)
+        #
+        #   @return [String, nil]
+        optional :id, String
+
+        # @!attribute created_at
+        #   When the account was created
+        #
+        #   @return [Time, nil]
+        optional :created_at, Time
+
+        # @!attribute description
+        #   Account description
+        #
+        #   @return [String, nil]
+        optional :description, String, nil?: true
+
+        # @!attribute icon
+        #   Account icon URL
+        #
+        #   @return [String, nil]
+        optional :icon, String, nil?: true
+
+        # @!attribute name
+        #   Account name
+        #
+        #   @return [String, nil]
+        optional :name, String
+
+        # @!attribute profiles
+        #   List of profiles (only for organization type)
+        #
+        #   @return [Array<Sentdm::Models::MeRetrieveResponse::Data::Profile>, nil]
+        optional :profiles,
+                 -> { Sentdm::Internal::Type::ArrayOf[Sentdm::Models::MeRetrieveResponse::Data::Profile] },
+                 nil?: true
+
+        # @!attribute settings
+        #   Profile settings (only for profile type)
+        #
+        #   @return [Sentdm::Models::ProfileSettings, nil]
+        optional :settings, -> { Sentdm::ProfileSettings }, nil?: true
+
+        # @!attribute status
+        #   Profile status (only for profile type): incomplete, pending_review, approved,
+        #   etc.
+        #
+        #   @return [String, nil]
+        optional :status, String, nil?: true
+
+        # @!method initialize(id: nil, created_at: nil, description: nil, icon: nil, name: nil, profiles: nil, settings: nil, status: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Sentdm::Models::MeRetrieveResponse::Data} for more details.
+        #
+        #   The response data (null if error)
+        #
+        #   @param id [String] Customer ID (organization or profile)
+        #
+        #   @param created_at [Time] When the account was created
+        #
+        #   @param description [String, nil] Account description
+        #
+        #   @param icon [String, nil] Account icon URL
+        #
+        #   @param name [String] Account name
+        #
+        #   @param profiles [Array<Sentdm::Models::MeRetrieveResponse::Data::Profile>, nil] List of profiles (only for organization type)
+        #
+        #   @param settings [Sentdm::Models::ProfileSettings, nil] Profile settings (only for profile type)
+        #
+        #   @param status [String, nil] Profile status (only for profile type): incomplete, pending_review, approved, et
+
+        class Profile < Sentdm::Internal::Type::BaseModel
+          # @!attribute id
+          #   Profile unique identifier
+          #
+          #   @return [String, nil]
+          optional :id, String
+
+          # @!attribute created_at
+          #   When the profile was created
+          #
+          #   @return [Time, nil]
+          optional :created_at, Time
+
+          # @!attribute description
+          #   Profile description
+          #
+          #   @return [String, nil]
+          optional :description, String, nil?: true
+
+          # @!attribute icon
+          #   Profile icon URL
+          #
+          #   @return [String, nil]
+          optional :icon, String, nil?: true
+
+          # @!attribute name
+          #   Profile name
+          #
+          #   @return [String, nil]
+          optional :name, String
+
+          # @!attribute role
+          #   User's role in this profile: admin, billing, developer (inherited from
+          #   organization if not explicitly set)
+          #
+          #   @return [String, nil]
+          optional :role, String, nil?: true
+
+          # @!attribute settings
+          #   Profile configuration settings
+          #
+          #   @return [Sentdm::Models::ProfileSettings, nil]
+          optional :settings, -> { Sentdm::ProfileSettings }
+
+          # @!attribute short_name
+          #   Profile short name (abbreviation)
+          #
+          #   @return [String, nil]
+          optional :short_name, String, nil?: true
+
+          # @!attribute status
+          #   Profile setup status: incomplete, pending_review, approved, rejected
+          #
+          #   @return [String, nil]
+          optional :status, String, nil?: true
+
+          # @!method initialize(id: nil, created_at: nil, description: nil, icon: nil, name: nil, role: nil, settings: nil, short_name: nil, status: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Sentdm::Models::MeRetrieveResponse::Data::Profile} for more details.
+          #
+          #   Profile (sender profile) response for v3 API
+          #
+          #   @param id [String] Profile unique identifier
+          #
+          #   @param created_at [Time] When the profile was created
+          #
+          #   @param description [String, nil] Profile description
+          #
+          #   @param icon [String, nil] Profile icon URL
+          #
+          #   @param name [String] Profile name
+          #
+          #   @param role [String, nil] User's role in this profile: admin, billing, developer (inherited from organizat
+          #
+          #   @param settings [Sentdm::Models::ProfileSettings] Profile configuration settings
+          #
+          #   @param short_name [String, nil] Profile short name (abbreviation)
+          #
+          #   @param status [String, nil] Profile setup status: incomplete, pending_review, approved, rejected
+        end
+      end
+    end
+  end
+end

data/lib/sentdm/models/message_retrieve_activities_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    # @see Sentdm::Resources::Messages#retrieve_activities
+    class MessageRetrieveActivitiesParams < 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/message_retrieve_activities_response.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    # @see Sentdm::Resources::Messages#retrieve_activities
+    class MessageRetrieveActivitiesResponse < Sentdm::Internal::Type::BaseModel
+      # @!attribute data
+      #   The response data (null if error)
+      #
+      #   @return [Sentdm::Models::MessageRetrieveActivitiesResponse::Data, nil]
+      optional :data, -> { Sentdm::Models::MessageRetrieveActivitiesResponse::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::MessageRetrieveActivitiesResponse::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::MessageRetrieveActivitiesResponse#data
+      class Data < Sentdm::Internal::Type::BaseModel
+        # @!attribute activities
+        #   List of activity events ordered by most recent first
+        #
+        #   @return [Array<Sentdm::Models::MessageRetrieveActivitiesResponse::Data::Activity>, nil]
+        optional :activities,
+                 -> { Sentdm::Internal::Type::ArrayOf[Sentdm::Models::MessageRetrieveActivitiesResponse::Data::Activity] }
+
+        # @!attribute message_id
+        #   The message ID these activities belong to
+        #
+        #   @return [String, nil]
+        optional :message_id, String
+
+        # @!method initialize(activities: nil, message_id: nil)
+        #   The response data (null if error)
+        #
+        #   @param activities [Array<Sentdm::Models::MessageRetrieveActivitiesResponse::Data::Activity>] List of activity events ordered by most recent first
+        #
+        #   @param message_id [String] The message ID these activities belong to
+
+        class Activity < Sentdm::Internal::Type::BaseModel
+          # @!attribute content
+          #   Additional content or payload for the activity (e.g., channel response)
+          #
+          #   @return [String, nil]
+          optional :content, String, nil?: true
+
+          # @!attribute description
+          #   Human-readable description of the activity
+          #
+          #   @return [String, nil]
+          optional :description, String
+
+          # @!attribute status
+          #   Activity status (e.g., ACCEPTED, PROCESSED, SENT, DELIVERED, FAILED)
+          #
+          #   @return [String, nil]
+          optional :status, String
+
+          # @!attribute timestamp
+          #   When this activity occurred
+          #
+          #   @return [Time, nil]
+          optional :timestamp, Time
+
+          # @!method initialize(content: nil, description: nil, status: nil, timestamp: nil)
+          #   A single message activity event for v3 API
+          #
+          #   @param content [String, nil] Additional content or payload for the activity (e.g., channel response)
+          #
+          #   @param description [String] Human-readable description of the activity
+          #
+          #   @param status [String] Activity status (e.g., ACCEPTED, PROCESSED, SENT, DELIVERED, FAILED)
+          #
+          #   @param timestamp [Time] When this activity occurred
+        end
+      end
+    end
+  end
+end

data/lib/sentdm/models/message_retrieve_status_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    # @see Sentdm::Resources::Messages#retrieve_status
+    class MessageRetrieveStatusParams < 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