sentdm 0.45.0 → 0.46.0

data/lib/sentdm/models/api_response_of_sender_profiles_list.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class APIResponseOfSenderProfilesList < Sentdm::Internal::Type::BaseModel
+      # @!attribute data
+      #   A paginated list of sender profiles.
+      #
+      #   @return [Sentdm::Models::SenderProfilesList, nil]
+      optional :data, -> { Sentdm::SenderProfilesList }, 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::SenderProfilesList, nil] A paginated list of sender profiles.
+      #
+      #   @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_templates_list.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class APIResponseOfTemplatesList < Sentdm::Internal::Type::BaseModel
+      # @!attribute data
+      #   A paginated list of templates.
+      #
+      #   @return [Sentdm::Models::TemplatesList, nil]
+      optional :data, -> { Sentdm::TemplatesList }, 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::TemplatesList, nil] A paginated list of templates.
+      #
+      #   @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_users_list.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    # @see Sentdm::Resources::Users#list
+    class APIResponseOfUsersList < Sentdm::Internal::Type::BaseModel
+      # @!attribute data
+      #   The users in the organization.
+      #
+      #   @return [Sentdm::Models::UsersList, nil]
+      optional :data, -> { Sentdm::UsersList }, 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::UsersList, nil] The users 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_webhook_event_types_list.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    # @see Sentdm::Resources::Webhooks#list_event_types
+    class APIResponseOfWebhookEventTypesList < Sentdm::Internal::Type::BaseModel
+      # @!attribute data
+      #   The webhook event types a customer can subscribe to.
+      #
+      #   @return [Sentdm::Models::WebhookEventTypesList, nil]
+      optional :data, -> { Sentdm::WebhookEventTypesList }, 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::WebhookEventTypesList, nil] The webhook event types a customer can subscribe to.
+      #
+      #   @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_webhook_events_list.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class APIResponseOfWebhookEventsList < Sentdm::Internal::Type::BaseModel
+      # @!attribute data
+      #   A paginated list of webhook delivery records.
+      #
+      #   @return [Sentdm::Models::WebhookEventsList, nil]
+      optional :data, -> { Sentdm::WebhookEventsList }, 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::WebhookEventsList, nil] A paginated list of webhook delivery records.
+      #
+      #   @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/{webhook_rotate_secret_response.rb → api_response_of_webhook_secret.rb}

@@ -3,12 +3,12 @@
 module Sentdm
   module Models
     # @see Sentdm::Resources::Webhooks#rotate_secret
-    class WebhookRotateSecretResponse < Sentdm::Internal::Type::BaseModel
+    class APIResponseOfWebhookSecret < Sentdm::Internal::Type::BaseModel
       # @!attribute data
       #   The response data (null if error)
       #
-      #   @return [Sentdm::Models::WebhookRotateSecretResponse::Data, nil]
-      optional :data, -> { Sentdm::Models::WebhookRotateSecretResponse::Data }, nil?: true
+      #   @return [Sentdm::Models::WebhookSecret, nil]
+      optional :data, -> { Sentdm::WebhookSecret }, nil?: true
 
       # @!attribute error
       #   Error information
@@ -31,26 +31,13 @@ module Sentdm
       # @!method initialize(data: nil, error: nil, meta: nil, success: nil)
       #   Standard API response envelope for all v3 endpoints
       #
-      #   @param data [Sentdm::Models::WebhookRotateSecretResponse::Data, nil] The response data (null if error)
+      #   @param data [Sentdm::Models::WebhookSecret, 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
-
-      # @see Sentdm::Models::WebhookRotateSecretResponse#data
-      class Data < Sentdm::Internal::Type::BaseModel
-        # @!attribute signing_secret
-        #
-        #   @return [String, nil]
-        optional :signing_secret, String
-
-        # @!method initialize(signing_secret: nil)
-        #   The response data (null if error)
-        #
-        #   @param signing_secret [String]
-      end
     end
   end
 end

data/lib/sentdm/models/{webhook_test_response.rb → api_response_of_webhook_test.rb}

@@ -3,12 +3,12 @@
 module Sentdm
   module Models
     # @see Sentdm::Resources::Webhooks#test_
-    class WebhookTestResponse < Sentdm::Internal::Type::BaseModel
+    class APIResponseOfWebhookTest < Sentdm::Internal::Type::BaseModel
       # @!attribute data
       #   The response data (null if error)
       #
-      #   @return [Sentdm::Models::WebhookTestResponse::Data, nil]
-      optional :data, -> { Sentdm::Models::WebhookTestResponse::Data }, nil?: true
+      #   @return [Sentdm::Models::WebhookTest, nil]
+      optional :data, -> { Sentdm::WebhookTest }, nil?: true
 
       # @!attribute error
       #   Error information
@@ -31,32 +31,13 @@ module Sentdm
       # @!method initialize(data: nil, error: nil, meta: nil, success: nil)
       #   Standard API response envelope for all v3 endpoints
       #
-      #   @param data [Sentdm::Models::WebhookTestResponse::Data, nil] The response data (null if error)
+      #   @param data [Sentdm::Models::WebhookTest, 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
-
-      # @see Sentdm::Models::WebhookTestResponse#data
-      class Data < Sentdm::Internal::Type::BaseModel
-        # @!attribute message
-        #
-        #   @return [String, nil]
-        optional :message, String
-
-        # @!attribute success
-        #
-        #   @return [Boolean, nil]
-        optional :success, Sentdm::Internal::Type::Boolean
-
-        # @!method initialize(message: nil, success: nil)
-        #   The response data (null if error)
-        #
-        #   @param message [String]
-        #   @param success [Boolean]
-      end
     end
   end
 end

data/lib/sentdm/models/api_response_of_webhooks_list.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class APIResponseOfWebhooksList < Sentdm::Internal::Type::BaseModel
+      # @!attribute data
+      #   A paginated list of webhooks.
+      #
+      #   @return [Sentdm::Models::WebhooksList, nil]
+      optional :data, -> { Sentdm::WebhooksList }, 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::WebhooksList, nil] A paginated list of webhooks.
+      #
+      #   @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/billing_contact.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class BillingContact < Sentdm::Internal::Type::BaseModel
+      # @!attribute address
+      #
+      #   @return [String, nil]
+      optional :address, String, nil?: true
+
+      # @!attribute email
+      #
+      #   @return [String, nil]
+      optional :email, String, nil?: true
+
+      # @!attribute name
+      #
+      #   @return [String, nil]
+      optional :name, String, nil?: true
+
+      # @!attribute phone
+      #
+      #   @return [String, nil]
+      optional :phone, String, nil?: true
+
+      # @!method initialize(address: nil, email: nil, name: nil, phone: nil)
+      #   Billing contact info returned in profile responses
+      #
+      #   @param address [String, nil]
+      #   @param email [String, nil]
+      #   @param name [String, nil]
+      #   @param phone [String, nil]
+    end
+  end
+end

data/lib/sentdm/models/brand_business.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class BrandBusiness < Sentdm::Internal::Type::BaseModel
+      # @!attribute city
+      #   City
+      #
+      #   @return [String, nil]
+      optional :city, String, nil?: true
+
+      # @!attribute country
+      #   Country code (e.g., US, CA)
+      #
+      #   @return [String, nil]
+      optional :country, String, nil?: true
+
+      # @!attribute country_of_registration
+      #   Country where the business is registered
+      #
+      #   @return [String, nil]
+      optional :country_of_registration, String, nil?: true
+
+      # @!attribute entity_type
+      #   Business entity type
+      #
+      #   @return [String, nil]
+      optional :entity_type, String, nil?: true
+
+      # @!attribute legal_name
+      #   Legal business name
+      #
+      #   @return [String, nil]
+      optional :legal_name, String, nil?: true
+
+      # @!attribute postal_code
+      #   Postal/ZIP code
+      #
+      #   @return [String, nil]
+      optional :postal_code, String, nil?: true
+
+      # @!attribute state
+      #   State/province code
+      #
+      #   @return [String, nil]
+      optional :state, String, nil?: true
+
+      # @!attribute street
+      #   Street address
+      #
+      #   @return [String, nil]
+      optional :street, String, nil?: true
+
+      # @!attribute tax_id
+      #   Tax ID/EIN number
+      #
+      #   @return [String, nil]
+      optional :tax_id, String, nil?: true
+
+      # @!attribute tax_id_type
+      #   Type of tax ID (e.g., us_ein, ca_bn)
+      #
+      #   @return [String, nil]
+      optional :tax_id_type, String, nil?: true
+
+      # @!attribute url
+      #   Business website URL
+      #
+      #   @return [String, nil]
+      optional :url, String, nil?: true
+
+      # @!method initialize(city: nil, country: nil, country_of_registration: nil, entity_type: nil, legal_name: nil, postal_code: nil, state: nil, street: nil, tax_id: nil, tax_id_type: nil, url: nil)
+      #   @param city [String, nil] City
+      #
+      #   @param country [String, nil] Country code (e.g., US, CA)
+      #
+      #   @param country_of_registration [String, nil] Country where the business is registered
+      #
+      #   @param entity_type [String, nil] Business entity type
+      #
+      #   @param legal_name [String, nil] Legal business name
+      #
+      #   @param postal_code [String, nil] Postal/ZIP code
+      #
+      #   @param state [String, nil] State/province code
+      #
+      #   @param street [String, nil] Street address
+      #
+      #   @param tax_id [String, nil] Tax ID/EIN number
+      #
+      #   @param tax_id_type [String, nil] Type of tax ID (e.g., us_ein, ca_bn)
+      #
+      #   @param url [String, nil] Business website URL
+    end
+  end
+end

data/lib/sentdm/models/brand_business_info.rb

@@ -23,11 +23,8 @@ module Sentdm
 
       # @!attribute entity_type
       #
-      #   @return [Symbol, Sentdm::Models::BrandBusinessInfo::EntityType, nil]
-      optional :entity_type,
-               enum: -> { Sentdm::BrandBusinessInfo::EntityType },
-               api_name: :entityType,
-               nil?: true
+      #   @return [Symbol, Sentdm::Models::EntityType, nil]
+      optional :entity_type, enum: -> { Sentdm::EntityType }, api_name: :entityType, nil?: true
 
       # @!attribute legal_name
       #   Legal business name
@@ -80,7 +77,7 @@ module Sentdm
       #
       #   @param country_of_registration [String, nil] Country where the business is registered
       #
-      #   @param entity_type [Symbol, Sentdm::Models::BrandBusinessInfo::EntityType, nil]
+      #   @param entity_type [Symbol, Sentdm::Models::EntityType, nil]
       #
       #   @param legal_name [String, nil] Legal business name
       #
@@ -95,20 +92,6 @@ module Sentdm
       #   @param tax_id_type [String, nil] Type of tax ID (e.g., us_ein, ca_bn)
       #
       #   @param url [String, nil] Business website URL
-
-      # @see Sentdm::Models::BrandBusinessInfo#entity_type
-      module EntityType
-        extend Sentdm::Internal::Type::Enum
-
-        PRIVATE_PROFIT = :PRIVATE_PROFIT
-        PUBLIC_PROFIT = :PUBLIC_PROFIT
-        NON_PROFIT = :NON_PROFIT
-        SOLE_PROPRIETOR = :SOLE_PROPRIETOR
-        GOVERNMENT = :GOVERNMENT
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
     end
   end
 end

data/lib/sentdm/models/brand_compliance.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class BrandCompliance < Sentdm::Internal::Type::BaseModel
+      # @!attribute brand_relationship
+      #
+      #   @return [Symbol, Sentdm::Models::TcrBrandRelationship, nil]
+      optional :brand_relationship, enum: -> { Sentdm::TcrBrandRelationship }, nil?: true
+
+      # @!attribute destination_countries
+      #   List of destination countries for messaging
+      #
+      #   @return [Array<Sentdm::Models::DestinationCountry>, nil]
+      optional :destination_countries, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::DestinationCountry] }
+
+      # @!attribute is_tcr_application
+      #   Whether this is a TCR (Campaign Registry) application
+      #
+      #   @return [Boolean, nil]
+      optional :is_tcr_application, Sentdm::Internal::Type::Boolean
+
+      # @!attribute notes
+      #   Additional notes about the business or use case
+      #
+      #   @return [String, nil]
+      optional :notes, String, nil?: true
+
+      # @!attribute phone_number_prefix
+      #   Phone number prefix for messaging (e.g., "+1")
+      #
+      #   @return [String, nil]
+      optional :phone_number_prefix, String, nil?: true
+
+      # @!attribute primary_use_case
+      #   @deprecated
+      #
+      #   Always null. The brand's free-text primary use case is no longer stored: it
+      #   reached neither TCR nor any decision, and its column is dropped with no
+      #   backfill, because the values were prose and the typed equivalent is the
+      #   campaign's MessagingUseCaseUS.
+      #
+      #   Retained so existing v3 clients reading primary_use_case keep deserializing.
+      #   Unlike the profile sharing flags, which can answer false truthfully, there is no
+      #   value to report here — the field is present and empty rather than present and
+      #   wrong.
+      #
+      #   @return [String, nil]
+      optional :primary_use_case, String, nil?: true
+
+      # @!attribute vertical
+      #
+      #   @return [Symbol, Sentdm::Models::TcrVertical, nil]
+      optional :vertical, enum: -> { Sentdm::TcrVertical }, nil?: true
+
+      # @!method initialize(brand_relationship: nil, destination_countries: nil, is_tcr_application: nil, notes: nil, phone_number_prefix: nil, primary_use_case: nil, vertical: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Sentdm::Models::BrandCompliance} for more details.
+      #
+      #   @param brand_relationship [Symbol, Sentdm::Models::TcrBrandRelationship, nil]
+      #
+      #   @param destination_countries [Array<Sentdm::Models::DestinationCountry>] List of destination countries for messaging
+      #
+      #   @param is_tcr_application [Boolean] Whether this is a TCR (Campaign Registry) application
+      #
+      #   @param notes [String, nil] Additional notes about the business or use case
+      #
+      #   @param phone_number_prefix [String, nil] Phone number prefix for messaging (e.g., "+1")
+      #
+      #   @param primary_use_case [String, nil] Always null. The brand's free-text primary use case is no longer stored: it reac
+      #
+      #   @param vertical [Symbol, Sentdm::Models::TcrVertical, nil]
+    end
+  end
+end

data/lib/sentdm/models/brand_contact.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class BrandContact < Sentdm::Internal::Type::BaseModel
+      # @!attribute business_name
+      #   Business/brand name
+      #
+      #   @return [String, nil]
+      optional :business_name, String, nil?: true
+
+      # @!attribute email
+      #   Contact email address
+      #
+      #   @return [String, nil]
+      optional :email, String, nil?: true
+
+      # @!attribute name
+      #   Primary contact name
+      #
+      #   @return [String, nil]
+      optional :name, String
+
+      # @!attribute phone
+      #   Contact phone number in E.164 format
+      #
+      #   @return [String, nil]
+      optional :phone, String, nil?: true
+
+      # @!attribute phone_country_code
+      #   Contact phone country code (e.g., "1" for US)
+      #
+      #   @return [String, nil]
+      optional :phone_country_code, String, nil?: true
+
+      # @!attribute role
+      #   Contact's role in the business
+      #
+      #   @return [String, nil]
+      optional :role, String, nil?: true
+
+      # @!method initialize(business_name: nil, email: nil, name: nil, phone: nil, phone_country_code: nil, role: nil)
+      #   @param business_name [String, nil] Business/brand name
+      #
+      #   @param email [String, nil] Contact email address
+      #
+      #   @param name [String] Primary contact name
+      #
+      #   @param phone [String, nil] Contact phone number in E.164 format
+      #
+      #   @param phone_country_code [String, nil] Contact phone country code (e.g., "1" for US)
+      #
+      #   @param role [String, nil] Contact's role in the business
+    end
+  end
+end