sentdm 0.29.0 → 0.31.0

data/lib/sentdm/internal/webhooks_page.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Internal
+    # @generic Elem
+    #
+    # @example
+    #   if webhooks_page.has_next?
+    #     webhooks_page = webhooks_page.next_page
+    #   end
+    #
+    # @example
+    #   webhooks_page.auto_paging_each do |webhook|
+    #     puts(webhook)
+    #   end
+    class WebhooksPage
+      include Sentdm::Internal::Type::BasePage
+
+      # @return [Data]
+      attr_accessor :data
+
+      # @return [Boolean]
+      def next_page?
+        data&.pagination&.has_more
+      end
+
+      # @raise [Sentdm::HTTP::Error]
+      # @return [self]
+      def next_page
+        unless next_page?
+          message = "No more pages available. Please check #next_page? before calling ##{__method__}"
+          raise RuntimeError.new(message)
+        end
+
+        req = Sentdm::Internal::Util.deep_merge(
+          @req,
+          {query: {page: @req.fetch(:query).fetch(:page, 1).to_i.succ}}
+        )
+        @client.request(req)
+      end
+
+      # @param blk [Proc]
+      #
+      # @yieldparam [generic<Elem>]
+      def auto_paging_each(&blk)
+        unless block_given?
+          raise ArgumentError.new("A block must be given to ##{__method__}")
+        end
+
+        page = self
+        loop do
+          page.data&.webhooks&.each(&blk)
+
+          break unless page.next_page?
+          page = page.next_page
+        end
+      end
+
+      # @api private
+      #
+      # @param client [Sentdm::Internal::Transport::BaseClient]
+      # @param req [Hash{Symbol=>Object}]
+      # @param headers [Hash{String=>String}]
+      # @param page_data [Hash{Symbol=>Object}]
+      def initialize(client:, req:, headers:, page_data:)
+        super
+
+        case page_data
+        in {data: Hash | nil => data}
+          if (webhooks = data[:webhooks]).is_a?(Array)
+            data = {**data, webhooks: webhooks.map { Sentdm::Internal::Type::Converter.coerce(@model, _1) }}
+          end
+          @data = Sentdm::Internal::Type::Converter.coerce(Sentdm::Internal::WebhooksPage::Data, data)
+        else
+        end
+      end
+
+      # @api private
+      #
+      # @return [String]
+      def inspect
+        model = Sentdm::Internal::Type::Converter.inspect(@model, depth: 1)
+
+        "#<#{self.class}[#{model}]:0x#{object_id.to_s(16)}>"
+      end
+
+      class Data < Sentdm::Internal::Type::BaseModel
+        # @!attribute pagination
+        #
+        #   @return [Data::Pagination, nil]
+        optional :pagination, -> { Data::Pagination }
+
+        # @!attribute webhooks
+        #
+        #   @return [Array<Object>, nil]
+        optional :webhooks, Sentdm::Internal::Type::ArrayOf[Sentdm::Internal::Type::Unknown]
+
+        # @!method initialize(pagination: nil, webhooks: nil)
+        #   @param pagination [Data::Pagination]
+        #   @param webhooks [Array<Object>]
+
+        # @see Data#pagination
+        class Pagination < Sentdm::Internal::Type::BaseModel
+          # @!attribute has_more
+          #
+          #   @return [Boolean, nil]
+          optional :has_more, Sentdm::Internal::Type::Boolean
+
+          # @!method initialize(has_more: nil)
+          #   @param has_more [Boolean]
+        end
+      end
+    end
+  end
+end

data/lib/sentdm/models/api_meta.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class APIMeta < 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
+    end
+  end
+end

data/lib/sentdm/models/api_response_of_contact.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    # @see Sentdm::Resources::Contacts#create
+    class APIResponseOfContact < Sentdm::Internal::Type::BaseModel
+      # @!attribute data
+      #   Contact response for v3 API Uses snake_case for JSON property names
+      #
+      #   @return [Sentdm::Models::ContactResponse, nil]
+      optional :data, -> { Sentdm::ContactResponse }, 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::APIResponseOfContact} for more details.
+      #
+      #   Standard API response envelope for all v3 endpoints
+      #
+      #   @param data [Sentdm::Models::ContactResponse, nil] Contact response for v3 API
+      #
+      #   @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_contact_message_summary.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    # @see Sentdm::Resources::Contacts#retrieve_message_summary
+    class APIResponseOfContactMessageSummary < Sentdm::Internal::Type::BaseModel
+      # @!attribute data
+      #   The response data (null if error)
+      #
+      #   @return [Sentdm::Models::ContactMessageSummary, nil]
+      optional :data, -> { Sentdm::ContactMessageSummary }, 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::ContactMessageSummary, 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_conversation_messages_list.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class APIResponseOfConversationMessagesList < Sentdm::Internal::Type::BaseModel
+      # @!attribute data
+      #   A paginated list of messages — used by both conversation read endpoints.
+      #
+      #   @return [Sentdm::Models::ConversationMessagesList, nil]
+      optional :data, -> { Sentdm::ConversationMessagesList }, 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::ConversationMessagesList, nil] A paginated list of messages — used by both conversation read endpoints.
+      #
+      #   @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_detail.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    # @see Sentdm::Resources::Profiles#create
+    class APIResponseOfProfileDetail < Sentdm::Internal::Type::BaseModel
+      # @!attribute data
+      #   Detailed profile response for v3 API
+      #
+      #   @return [Sentdm::Models::ProfileDetail, nil]
+      optional :data, -> { Sentdm::ProfileDetail }, 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::ProfileDetail, nil] Detailed profile response for v3 API
+      #
+      #   @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_user.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    # @see Sentdm::Resources::Users#retrieve
+    class APIResponseOfUser < Sentdm::Internal::Type::BaseModel
+      # @!attribute data
+      #   User response for v3 API
+      #
+      #   @return [Sentdm::Models::UserResponse, nil]
+      optional :data, -> { Sentdm::UserResponse }, 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::UserResponse, nil] User response for v3 API
+      #
+      #   @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_template.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    # @see Sentdm::Resources::Templates#create
+    class APIResponseTemplate < Sentdm::Internal::Type::BaseModel
+      # @!attribute data
+      #   Template response for v3 API
+      #
+      #   @return [Sentdm::Models::Template, nil]
+      optional :data, -> { Sentdm::Template }, 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::Template, nil] Template response for v3 API
+      #
+      #   @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_webhook.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    # @see Sentdm::Resources::Webhooks#create
+    class APIResponseWebhook < Sentdm::Internal::Type::BaseModel
+      # @!attribute data
+      #   The response data (null if error)
+      #
+      #   @return [Sentdm::Models::WebhookResponse, nil]
+      optional :data, -> { Sentdm::WebhookResponse }, 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::WebhookResponse, 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/billing_contact_info.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class BillingContactInfo < Sentdm::Internal::Type::BaseModel
+      # @!attribute email
+      #   Email address where invoices will be sent (required)
+      #
+      #   @return [String]
+      required :email, String
+
+      # @!attribute name
+      #   Full name of the billing contact or company (required)
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute address
+      #   Billing address (optional). Free-form text including street, city, state, postal
+      #   code, and country.
+      #
+      #   @return [String, nil]
+      optional :address, String, nil?: true
+
+      # @!attribute phone
+      #   Phone number for the billing contact (optional)
+      #
+      #   @return [String, nil]
+      optional :phone, String, nil?: true
+
+      # @!method initialize(email:, name:, address: nil, phone: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Sentdm::Models::BillingContactInfo} for more details.
+      #
+      #   Billing contact information for a profile. Required when billing_model is
+      #   "profile" or "profile_and_organization".
+      #
+      #   @param email [String] Email address where invoices will be sent (required)
+      #
+      #   @param name [String] Full name of the billing contact or company (required)
+      #
+      #   @param address [String, nil] Billing address (optional). Free-form text including street, city, state, postal
+      #
+      #   @param phone [String, nil] Phone number for the billing contact (optional)
+    end
+  end
+end

data/lib/sentdm/models/brand_business_info.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class BrandBusinessInfo < 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, api_name: :countryOfRegistration, nil?: true
+
+      # @!attribute entity_type
+      #
+      #   @return [Symbol, Sentdm::Models::BrandBusinessInfo::EntityType, nil]
+      optional :entity_type,
+               enum: -> { Sentdm::BrandBusinessInfo::EntityType },
+               api_name: :entityType,
+               nil?: true
+
+      # @!attribute legal_name
+      #   Legal business name
+      #
+      #   @return [String, nil]
+      optional :legal_name, String, api_name: :legalName, nil?: true
+
+      # @!attribute postal_code
+      #   Postal/ZIP code
+      #
+      #   @return [String, nil]
+      optional :postal_code, String, api_name: :postalCode, 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, api_name: :taxId, nil?: true
+
+      # @!attribute tax_id_type
+      #   Type of tax ID (e.g., us_ein, ca_bn)
+      #
+      #   @return [String, nil]
+      optional :tax_id_type, String, api_name: :taxIdType, 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)
+      #   Business details and address for brand KYC
+      #
+      #   @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 [Symbol, Sentdm::Models::BrandBusinessInfo::EntityType, nil]
+      #
+      #   @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
+
+      # @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_info.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class BrandComplianceInfo < Sentdm::Internal::Type::BaseModel
+      # @!attribute brand_relationship
+      #
+      #   @return [Symbol, Sentdm::Models::TcrBrandRelationship]
+      required :brand_relationship, enum: -> { Sentdm::TcrBrandRelationship }, api_name: :brandRelationship
+
+      # @!attribute vertical
+      #
+      #   @return [Symbol, Sentdm::Models::TcrVertical]
+      required :vertical, enum: -> { Sentdm::TcrVertical }
+
+      # @!attribute destination_countries
+      #   List of destination countries for messaging
+      #
+      #   @return [Array<Sentdm::Models::DestinationCountry>, nil]
+      optional :destination_countries,
+               -> { Sentdm::Internal::Type::ArrayOf[Sentdm::DestinationCountry] },
+               api_name: :destinationCountries,
+               nil?: true
+
+      # @!attribute is_tcr_application
+      #   Whether this is a TCR (Campaign Registry) application
+      #
+      #   @return [Boolean, nil]
+      optional :is_tcr_application, Sentdm::Internal::Type::Boolean, api_name: :isTcrApplication, nil?: true
+
+      # @!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, api_name: :phoneNumberPrefix, nil?: true
+
+      # @!method initialize(brand_relationship:, vertical:, destination_countries: nil, is_tcr_application: nil, notes: nil, phone_number_prefix: nil)
+      #   Compliance and TCR information for brand registration
+      #
+      #   @param brand_relationship [Symbol, Sentdm::Models::TcrBrandRelationship]
+      #
+      #   @param vertical [Symbol, Sentdm::Models::TcrVertical]
+      #
+      #   @param destination_countries [Array<Sentdm::Models::DestinationCountry>, nil] List of destination countries for messaging
+      #
+      #   @param is_tcr_application [Boolean, nil] 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")
+    end
+  end
+end