sentdm 0.45.0 → 0.46.0

data/lib/sentdm/models/account_rcs_channel.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class AccountRcsChannel < Sentdm::Internal::Type::BaseModel
+      # @!attribute configured
+      #   Whether RCS is configured for this account
+      #
+      #   @return [Boolean, nil]
+      optional :configured, Sentdm::Internal::Type::Boolean
+
+      # @!attribute phone_number
+      #   RCS-enabled phone number in E.164 format
+      #
+      #   @return [String, nil]
+      optional :phone_number, String, nil?: true
+
+      # @!method initialize(configured: nil, phone_number: nil)
+      #   RCS channel configuration. When configured, includes the RCS phone number.
+      #
+      #   @param configured [Boolean] Whether RCS is configured for this account
+      #
+      #   @param phone_number [String, nil] RCS-enabled phone number in E.164 format
+    end
+  end
+end

data/lib/sentdm/models/account_sms_channel.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class AccountSMSChannel < Sentdm::Internal::Type::BaseModel
+      # @!attribute configured
+      #   Whether SMS is configured for this account
+      #
+      #   @return [Boolean, nil]
+      optional :configured, Sentdm::Internal::Type::Boolean
+
+      # @!attribute phone_number
+      #   Sending phone number in E.164 format
+      #
+      #   @return [String, nil]
+      optional :phone_number, String, nil?: true
+
+      # @!method initialize(configured: nil, phone_number: nil)
+      #   SMS channel configuration. When configured, includes the sending phone number.
+      #
+      #   @param configured [Boolean] Whether SMS is configured for this account
+      #
+      #   @param phone_number [String, nil] Sending phone number in E.164 format
+    end
+  end
+end

data/lib/sentdm/models/account_whatsapp_channel.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class AccountWhatsappChannel < Sentdm::Internal::Type::BaseModel
+      # @!attribute business_name
+      #   WhatsApp Business display name
+      #
+      #   @return [String, nil]
+      optional :business_name, String, nil?: true
+
+      # @!attribute configured
+      #   Whether WhatsApp is configured for this account
+      #
+      #   @return [Boolean, nil]
+      optional :configured, Sentdm::Internal::Type::Boolean
+
+      # @!attribute phone_number
+      #   WhatsApp phone number in E.164 format
+      #
+      #   @return [String, nil]
+      optional :phone_number, String, nil?: true
+
+      # @!method initialize(business_name: nil, configured: nil, phone_number: nil)
+      #   WhatsApp Business channel configuration. When configured, includes the WhatsApp
+      #   phone number and business name.
+      #
+      #   @param business_name [String, nil] WhatsApp Business display name
+      #
+      #   @param configured [Boolean] Whether WhatsApp is configured for this account
+      #
+      #   @param phone_number [String, nil] WhatsApp phone number in E.164 format
+    end
+  end
+end

data/lib/sentdm/models/api_response_of_account.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    # @see Sentdm::Resources::Me#retrieve
+    class APIResponseOfAccount < Sentdm::Internal::Type::BaseModel
+      # @!attribute data
+      #   Account response for GET /v3/me endpoint. Returns organization (with profiles),
+      #   user (standalone), or profile (child of an organization) data depending on the
+      #   API key type. Always includes messaging channel configuration.
+      #
+      #   @return [Sentdm::Models::Account, nil]
+      optional :data, -> { Sentdm::Account }, nil?: true
+
+      # @!attribute error
+      #   Error information
+      #
+      #   @return [Sentdm::Models::ErrorDetail, nil]
+      optional :error, -> { Sentdm::ErrorDetail }, nil?: true
+
+      # @!attribute meta
+      #   Request and response metadata
+      #
+      #   @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)
+      #   Some parameter documentations has been truncated, see
+      #   {Sentdm::Models::APIResponseOfAccount} for more details.
+      #
+      #   Standard API response envelope for all v3 endpoints
+      #
+      #   @param data [Sentdm::Models::Account, nil] Account response for GET /v3/me endpoint.
+      #
+      #   @param error [Sentdm::Models::ErrorDetail, nil] Error information
+      #
+      #   @param meta [Sentdm::Models::APIMeta] Request and response metadata
+      #
+      #   @param success [Boolean] Indicates whether the request was successful
+    end
+  end
+end

data/lib/sentdm/models/api_response_of_cancelled_message.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    # @see Sentdm::Resources::Messages#cancel
+    class APIResponseOfCancelledMessage < Sentdm::Internal::Type::BaseModel
+      # @!attribute data
+      #   The response data (null if error)
+      #
+      #   @return [Sentdm::Models::CancelledMessage, nil]
+      optional :data, -> { Sentdm::CancelledMessage }, nil?: true
+
+      # @!attribute error
+      #   Error information
+      #
+      #   @return [Sentdm::Models::ErrorDetail, nil]
+      optional :error, -> { Sentdm::ErrorDetail }, nil?: true
+
+      # @!attribute meta
+      #   Request and response metadata
+      #
+      #   @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::CancelledMessage, nil] The response data (null if error)
+      #
+      #   @param error [Sentdm::Models::ErrorDetail, nil] Error information
+      #
+      #   @param meta [Sentdm::Models::APIMeta] Request and response metadata
+      #
+      #   @param success [Boolean] Indicates whether the request was successful
+    end
+  end
+end

data/lib/sentdm/models/api_response_of_channels_state.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    # @see Sentdm::Resources::Channels#list
+    class APIResponseOfChannelsState < Sentdm::Internal::Type::BaseModel
+      # @!attribute data
+      #   The channels a profile sends on. SMS is a list because a profile can send in
+      #   several markets; WhatsApp and RCS are single, because a profile has one business
+      #   account and one agent.
+      #
+      #   @return [Sentdm::Models::ChannelsState, nil]
+      optional :data, -> { Sentdm::ChannelsState }, nil?: true
+
+      # @!attribute error
+      #   Error information
+      #
+      #   @return [Sentdm::Models::ErrorDetail, nil]
+      optional :error, -> { Sentdm::ErrorDetail }, nil?: true
+
+      # @!attribute meta
+      #   Request and response metadata
+      #
+      #   @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)
+      #   Some parameter documentations has been truncated, see
+      #   {Sentdm::Models::APIResponseOfChannelsState} for more details.
+      #
+      #   Standard API response envelope for all v3 endpoints
+      #
+      #   @param data [Sentdm::Models::ChannelsState, nil] The channels a profile sends on. SMS is a list because a profile can send in sev
+      #
+      #   @param error [Sentdm::Models::ErrorDetail, nil] Error information
+      #
+      #   @param meta [Sentdm::Models::APIMeta] Request and response metadata
+      #
+      #   @param success [Boolean] Indicates whether the request was successful
+    end
+  end
+end

data/lib/sentdm/models/api_response_of_compliance_requirements.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    # @see Sentdm::Resources::Compliance#retrieve_requirements
+    class APIResponseOfComplianceRequirements < Sentdm::Internal::Type::BaseModel
+      # @!attribute data
+      #   Everything a market expects of a sender, for one channel, country and sender
+      #   type.
+      #
+      #   @return [Sentdm::Models::ComplianceRequirements, nil]
+      optional :data, -> { Sentdm::ComplianceRequirements }, nil?: true
+
+      # @!attribute error
+      #   Error information
+      #
+      #   @return [Sentdm::Models::ErrorDetail, nil]
+      optional :error, -> { Sentdm::ErrorDetail }, nil?: true
+
+      # @!attribute meta
+      #   Request and response metadata
+      #
+      #   @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)
+      #   Some parameter documentations has been truncated, see
+      #   {Sentdm::Models::APIResponseOfComplianceRequirements} for more details.
+      #
+      #   Standard API response envelope for all v3 endpoints
+      #
+      #   @param data [Sentdm::Models::ComplianceRequirements, nil] Everything a market expects of a sender, for one channel, country and sender typ
+      #
+      #   @param error [Sentdm::Models::ErrorDetail, nil] Error information
+      #
+      #   @param meta [Sentdm::Models::APIMeta] Request and response metadata
+      #
+      #   @param success [Boolean] Indicates whether the request was successful
+    end
+  end
+end

data/lib/sentdm/models/api_response_of_contacts_list.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class APIResponseOfContactsList < Sentdm::Internal::Type::BaseModel
+      # @!attribute data
+      #   A paginated list of contacts.
+      #
+      #   @return [Sentdm::Models::ContactsList, nil]
+      optional :data, -> { Sentdm::ContactsList }, nil?: true
+
+      # @!attribute error
+      #   Error information
+      #
+      #   @return [Sentdm::Models::ErrorDetail, nil]
+      optional :error, -> { Sentdm::ErrorDetail }, nil?: true
+
+      # @!attribute meta
+      #   Request and response metadata
+      #
+      #   @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::ContactsList, nil] A paginated list of contacts.
+      #
+      #   @param error [Sentdm::Models::ErrorDetail, nil] Error information
+      #
+      #   @param meta [Sentdm::Models::APIMeta] Request and response metadata
+      #
+      #   @param success [Boolean] Indicates whether the request was successful
+    end
+  end
+end

data/lib/sentdm/models/api_response_of_message.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    # @see Sentdm::Resources::Messages#retrieve_status
+    class APIResponseOfMessage < Sentdm::Internal::Type::BaseModel
+      # @!attribute data
+      #   Message response for v3 API — same shape as v2 with snake_case JSON conventions.
+      #
+      #   The shape of a message that was sent immediately: it never has a scheduled_at
+      #   key. A message that is or was held for a later instant is a
+      #   ScheduledMessageResponse, and the endpoint decides which of the two to answer
+      #   with. From always returns this type.
+      #
+      #   @return [Sentdm::Models::Message, nil]
+      optional :data, -> { Sentdm::Message }, nil?: true
+
+      # @!attribute error
+      #   Error information
+      #
+      #   @return [Sentdm::Models::ErrorDetail, nil]
+      optional :error, -> { Sentdm::ErrorDetail }, nil?: true
+
+      # @!attribute meta
+      #   Request and response metadata
+      #
+      #   @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)
+      #   Some parameter documentations has been truncated, see
+      #   {Sentdm::Models::APIResponseOfMessage} for more details.
+      #
+      #   Standard API response envelope for all v3 endpoints
+      #
+      #   @param data [Sentdm::Models::Message, nil] Message response for v3 API — same shape as v2 with snake_case JSON conventions.
+      #
+      #   @param error [Sentdm::Models::ErrorDetail, nil] Error information
+      #
+      #   @param meta [Sentdm::Models::APIMeta] Request and response metadata
+      #
+      #   @param success [Boolean] Indicates whether the request was successful
+    end
+  end
+end

data/lib/sentdm/models/api_response_of_message_activities.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    # @see Sentdm::Resources::Messages#retrieve_activities
+    class APIResponseOfMessageActivities < Sentdm::Internal::Type::BaseModel
+      # @!attribute data
+      #   Response for GET /messages/{id}/activities
+      #
+      #   @return [Sentdm::Models::MessageActivities, nil]
+      optional :data, -> { Sentdm::MessageActivities }, nil?: true
+
+      # @!attribute error
+      #   Error information
+      #
+      #   @return [Sentdm::Models::ErrorDetail, nil]
+      optional :error, -> { Sentdm::ErrorDetail }, nil?: true
+
+      # @!attribute meta
+      #   Request and response metadata
+      #
+      #   @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::MessageActivities, nil] Response for GET /messages/{id}/activities
+      #
+      #   @param error [Sentdm::Models::ErrorDetail, nil] Error information
+      #
+      #   @param meta [Sentdm::Models::APIMeta] Request and response metadata
+      #
+      #   @param success [Boolean] Indicates whether the request was successful
+    end
+  end
+end

data/lib/sentdm/models/api_response_of_number_lookup_result.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    # @see Sentdm::Resources::Numbers#lookup
+    class APIResponseOfNumberLookupResult < Sentdm::Internal::Type::BaseModel
+      # @!attribute data
+      #   The response data (null if error)
+      #
+      #   @return [Sentdm::Models::NumberLookupResult, nil]
+      optional :data, -> { Sentdm::NumberLookupResult }, nil?: true
+
+      # @!attribute error
+      #   Error information
+      #
+      #   @return [Sentdm::Models::ErrorDetail, nil]
+      optional :error, -> { Sentdm::ErrorDetail }, nil?: true
+
+      # @!attribute meta
+      #   Request and response metadata
+      #
+      #   @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::NumberLookupResult, nil] The response data (null if error)
+      #
+      #   @param error [Sentdm::Models::ErrorDetail, nil] Error information
+      #
+      #   @param meta [Sentdm::Models::APIMeta] Request and response metadata
+      #
+      #   @param success [Boolean] Indicates whether the request was successful
+    end
+  end
+end

data/lib/sentdm/models/api_response_of_profile_completion_accepted.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class APIResponseOfProfileCompletionAccepted < Sentdm::Internal::Type::BaseModel
+      # @!attribute data
+      #   Response acknowledging that profile completion has been accepted and started in
+      #   the background. The provided webhook URL will be called when processing
+      #   finishes.
+      #
+      #   @return [Sentdm::Models::ProfileCompletionAccepted, nil]
+      optional :data, -> { Sentdm::ProfileCompletionAccepted }, nil?: true
+
+      # @!attribute error
+      #   Error information
+      #
+      #   @return [Sentdm::Models::ErrorDetail, nil]
+      optional :error, -> { Sentdm::ErrorDetail }, nil?: true
+
+      # @!attribute meta
+      #   Request and response metadata
+      #
+      #   @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)
+      #   Some parameter documentations has been truncated, see
+      #   {Sentdm::Models::APIResponseOfProfileCompletionAccepted} for more details.
+      #
+      #   Standard API response envelope for all v3 endpoints
+      #
+      #   @param data [Sentdm::Models::ProfileCompletionAccepted, nil] Response acknowledging that profile completion has been accepted and started in
+      #
+      #   @param error [Sentdm::Models::ErrorDetail, nil] Error information
+      #
+      #   @param meta [Sentdm::Models::APIMeta] Request and response metadata
+      #
+      #   @param success [Boolean] Indicates whether the request was successful
+    end
+  end
+end

data/lib/sentdm/models/api_response_of_profile_completion_result.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    # @see Sentdm::Resources::Profiles#complete
+    class APIResponseOfProfileCompletionResult < Sentdm::Internal::Type::BaseModel
+      # @!attribute data
+      #   Response when a profile is already in the completed state and no further action
+      #   is taken.
+      #
+      #   @return [Sentdm::Models::ProfileCompletionResult, nil]
+      optional :data, -> { Sentdm::ProfileCompletionResult }, nil?: true
+
+      # @!attribute error
+      #   Error information
+      #
+      #   @return [Sentdm::Models::ErrorDetail, nil]
+      optional :error, -> { Sentdm::ErrorDetail }, nil?: true
+
+      # @!attribute meta
+      #   Request and response metadata
+      #
+      #   @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)
+      #   Some parameter documentations has been truncated, see
+      #   {Sentdm::Models::APIResponseOfProfileCompletionResult} for more details.
+      #
+      #   Standard API response envelope for all v3 endpoints
+      #
+      #   @param data [Sentdm::Models::ProfileCompletionResult, nil] Response when a profile is already in the completed state and no further action
+      #
+      #   @param error [Sentdm::Models::ErrorDetail, nil] Error information
+      #
+      #   @param meta [Sentdm::Models::APIMeta] Request and response metadata
+      #
+      #   @param success [Boolean] Indicates whether the request was successful
+    end
+  end
+end

data/lib/sentdm/models/api_response_of_profiles_list.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    # @see Sentdm::Resources::Profiles#list
+    class APIResponseOfProfilesList < Sentdm::Internal::Type::BaseModel
+      # @!attribute data
+      #   The profiles in the organization.
+      #
+      #   @return [Sentdm::Models::ProfilesList, nil]
+      optional :data, -> { Sentdm::ProfilesList }, nil?: true
+
+      # @!attribute error
+      #   Error information
+      #
+      #   @return [Sentdm::Models::ErrorDetail, nil]
+      optional :error, -> { Sentdm::ErrorDetail }, nil?: true
+
+      # @!attribute meta
+      #   Request and response metadata
+      #
+      #   @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::ProfilesList, nil] The profiles in the organization.
+      #
+      #   @param error [Sentdm::Models::ErrorDetail, nil] Error information
+      #
+      #   @param meta [Sentdm::Models::APIMeta] Request and response metadata
+      #
+      #   @param success [Boolean] Indicates whether the request was successful
+    end
+  end
+end

data/lib/sentdm/models/api_response_of_sender_profile.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    # @see Sentdm::Resources::SenderProfiles#create
+    class APIResponseOfSenderProfile < Sentdm::Internal::Type::BaseModel
+      # @!attribute data
+      #   A sender profile as the API reports it — the same document the create call
+      #   accepts, plus the read-only facts it cannot: each market's status and what it
+      #   still owes.
+      #
+      #   No status at the profile, brand or campaign level. Brand and campaign are
+      #   identity, and identity has no lifecycle. What has one is the registration of a
+      #   sender in a market, and the approval of a channel — so status lives there, where
+      #   it says which specific thing is blocked rather than flattening several answers
+      #   into one.
+      #
+      #   @return [Sentdm::Models::SenderProfile, nil]
+      optional :data, -> { Sentdm::SenderProfile }, nil?: true
+
+      # @!attribute error
+      #   Error information
+      #
+      #   @return [Sentdm::Models::ErrorDetail, nil]
+      optional :error, -> { Sentdm::ErrorDetail }, nil?: true
+
+      # @!attribute meta
+      #   Request and response metadata
+      #
+      #   @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)
+      #   Some parameter documentations has been truncated, see
+      #   {Sentdm::Models::APIResponseOfSenderProfile} for more details.
+      #
+      #   Standard API response envelope for all v3 endpoints
+      #
+      #   @param data [Sentdm::Models::SenderProfile, nil] A sender profile as the API reports it — the same document the create call accep
+      #
+      #   @param error [Sentdm::Models::ErrorDetail, nil] Error information
+      #
+      #   @param meta [Sentdm::Models::APIMeta] Request and response metadata
+      #
+      #   @param success [Boolean] Indicates whether the request was successful
+    end
+  end
+end