sentdm 0.2.0 → 0.3.1

data/lib/sentdm/models/brands/campaign_update_params.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Brands
+      # @see Sentdm::Resources::Brands::Campaigns#update
+      class CampaignUpdateParams < Sentdm::Internal::Type::BaseModel
+        extend Sentdm::Internal::Type::RequestParameters::Converter
+        include Sentdm::Internal::Type::RequestParameters
+
+        # @!attribute brand_id
+        #
+        #   @return [String]
+        required :brand_id, String
+
+        # @!attribute campaign_id
+        #
+        #   @return [String]
+        required :campaign_id, String
+
+        # @!attribute campaign
+        #   Campaign data
+        #
+        #   @return [Sentdm::Models::Brands::CampaignData]
+        required :campaign, -> { Sentdm::Brands::CampaignData }
+
+        # @!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(brand_id:, campaign_id:, campaign:, test_mode: nil, idempotency_key: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Sentdm::Models::Brands::CampaignUpdateParams} for more details.
+        #
+        #   @param brand_id [String]
+        #
+        #   @param campaign_id [String]
+        #
+        #   @param campaign [Sentdm::Models::Brands::CampaignData] Campaign data
+        #
+        #   @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
+end

data/lib/sentdm/models/brands/messaging_use_case_us.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Brands
+      module MessagingUseCaseUs
+        extend Sentdm::Internal::Type::Enum
+
+        MARKETING = :MARKETING
+        ACCOUNT_NOTIFICATION = :ACCOUNT_NOTIFICATION
+        CUSTOMER_CARE = :CUSTOMER_CARE
+        FRAUD_ALERT = :FRAUD_ALERT
+        TWO_FA = :TWO_FA
+        DELIVERY_NOTIFICATION = :DELIVERY_NOTIFICATION
+        SECURITY_ALERT = :SECURITY_ALERT
+        M2_M = :M2M
+        MIXED = :MIXED
+        HIGHER_EDUCATION = :HIGHER_EDUCATION
+        POLLING_VOTING = :POLLING_VOTING
+        PUBLIC_SERVICE_ANNOUNCEMENT = :PUBLIC_SERVICE_ANNOUNCEMENT
+        LOW_VOLUME = :LOW_VOLUME
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/sentdm/models/brands/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_campaigns_campaign_use_case_data.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Brands
+      class SentDmServicesEndpointsCustomerApIv3ContractsRequestsCampaignsCampaignUseCaseData < Sentdm::Internal::Type::BaseModel
+        # @!attribute messaging_use_case_us
+        #   US messaging use case category
+        #
+        #   @return [Symbol, Sentdm::Models::Brands::MessagingUseCaseUs]
+        required :messaging_use_case_us,
+                 enum: -> { Sentdm::Brands::MessagingUseCaseUs },
+                 api_name: :messagingUseCaseUs
+
+        # @!attribute sample_messages
+        #   Sample messages for this use case (1-5 messages, max 1024 characters each)
+        #
+        #   @return [Array<String>]
+        required :sample_messages, Sentdm::Internal::Type::ArrayOf[String], api_name: :sampleMessages
+
+        # @!method initialize(messaging_use_case_us:, sample_messages:)
+        #   Campaign use case with sample messages
+        #
+        #   @param messaging_use_case_us [Symbol, Sentdm::Models::Brands::MessagingUseCaseUs] US messaging use case category
+        #
+        #   @param sample_messages [Array<String>] Sample messages for this use case (1-5 messages, max 1024 characters each)
+      end
+    end
+  end
+end

data/lib/sentdm/models/brands/tcr_campaign_with_use_cases.rb

@@ -0,0 +1,236 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Brands
+      class TcrCampaignWithUseCases < Sentdm::Models::Brands::BaseDto
+        # @!attribute billed_date
+        #
+        #   @return [Time, nil]
+        optional :billed_date, Time, api_name: :billedDate, nil?: true
+
+        # @!attribute brand_id
+        #
+        #   @return [String, nil]
+        optional :brand_id, String, api_name: :brandId, nil?: true
+
+        # @!attribute cost
+        #
+        #   @return [Float, nil]
+        optional :cost, Float, nil?: true
+
+        # @!attribute csp_id
+        #
+        #   @return [String, nil]
+        optional :csp_id, String, api_name: :cspId, nil?: true
+
+        # @!attribute customer_id
+        #
+        #   @return [String, nil]
+        optional :customer_id, String, api_name: :customerId
+
+        # @!attribute description
+        #
+        #   @return [String, nil]
+        optional :description, String
+
+        # @!attribute help_keywords
+        #
+        #   @return [String, nil]
+        optional :help_keywords, String, api_name: :helpKeywords, nil?: true
+
+        # @!attribute help_message
+        #
+        #   @return [String, nil]
+        optional :help_message, String, api_name: :helpMessage, nil?: true
+
+        # @!attribute kyc_submission_form_id
+        #
+        #   @return [String, nil]
+        optional :kyc_submission_form_id, String, api_name: :kycSubmissionFormId, nil?: true
+
+        # @!attribute message_flow
+        #
+        #   @return [String, nil]
+        optional :message_flow, String, api_name: :messageFlow, nil?: true
+
+        # @!attribute name
+        #
+        #   @return [String, nil]
+        optional :name, String
+
+        # @!attribute optin_keywords
+        #
+        #   @return [String, nil]
+        optional :optin_keywords, String, api_name: :optinKeywords, nil?: true
+
+        # @!attribute optin_message
+        #
+        #   @return [String, nil]
+        optional :optin_message, String, api_name: :optinMessage, nil?: true
+
+        # @!attribute optout_keywords
+        #
+        #   @return [String, nil]
+        optional :optout_keywords, String, api_name: :optoutKeywords, nil?: true
+
+        # @!attribute optout_message
+        #
+        #   @return [String, nil]
+        optional :optout_message, String, api_name: :optoutMessage, nil?: true
+
+        # @!attribute privacy_policy_link
+        #
+        #   @return [String, nil]
+        optional :privacy_policy_link, String, api_name: :privacyPolicyLink, nil?: true
+
+        # @!attribute reseller_id
+        #
+        #   @return [String, nil]
+        optional :reseller_id, String, api_name: :resellerId, nil?: true
+
+        # @!attribute sharing_status
+        #
+        #   @return [Symbol, Sentdm::Models::Brands::TcrCampaignWithUseCases::SharingStatus, nil]
+        optional :sharing_status,
+                 enum: -> { Sentdm::Brands::TcrCampaignWithUseCases::SharingStatus },
+                 api_name: :sharingStatus,
+                 nil?: true
+
+        # @!attribute status
+        #
+        #   @return [Symbol, Sentdm::Models::Brands::TcrCampaignWithUseCases::Status, nil]
+        optional :status, enum: -> { Sentdm::Brands::TcrCampaignWithUseCases::Status }, nil?: true
+
+        # @!attribute submitted_at
+        #
+        #   @return [Time, nil]
+        optional :submitted_at, Time, api_name: :submittedAt, nil?: true
+
+        # @!attribute submitted_to_tcr
+        #
+        #   @return [Boolean, nil]
+        optional :submitted_to_tcr, Sentdm::Internal::Type::Boolean, api_name: :submittedToTCR
+
+        # @!attribute tcr_campaign_id
+        #
+        #   @return [String, nil]
+        optional :tcr_campaign_id, String, api_name: :tcrCampaignId, nil?: true
+
+        # @!attribute tcr_sync_error
+        #
+        #   @return [String, nil]
+        optional :tcr_sync_error, String, api_name: :tcrSyncError, nil?: true
+
+        # @!attribute telnyx_campaign_id
+        #
+        #   @return [String, nil]
+        optional :telnyx_campaign_id, String, api_name: :telnyxCampaignId, nil?: true
+
+        # @!attribute terms_and_conditions_link
+        #
+        #   @return [String, nil]
+        optional :terms_and_conditions_link, String, api_name: :termsAndConditionsLink, nil?: true
+
+        # @!attribute type
+        #
+        #   @return [String, nil]
+        optional :type, String
+
+        # @!attribute upstream_cnp_id
+        #
+        #   @return [String, nil]
+        optional :upstream_cnp_id, String, api_name: :upstreamCnpId, nil?: true
+
+        # @!attribute use_cases
+        #
+        #   @return [Array<Sentdm::Models::Brands::TcrCampaignWithUseCases::UseCase>, nil]
+        optional :use_cases,
+                 -> { Sentdm::Internal::Type::ArrayOf[Sentdm::Brands::TcrCampaignWithUseCases::UseCase] },
+                 api_name: :useCases
+
+        # @!method initialize(billed_date: nil, brand_id: nil, cost: nil, csp_id: nil, customer_id: nil, description: nil, help_keywords: nil, help_message: nil, kyc_submission_form_id: nil, message_flow: nil, name: nil, optin_keywords: nil, optin_message: nil, optout_keywords: nil, optout_message: nil, privacy_policy_link: nil, reseller_id: nil, sharing_status: nil, status: nil, submitted_at: nil, submitted_to_tcr: nil, tcr_campaign_id: nil, tcr_sync_error: nil, telnyx_campaign_id: nil, terms_and_conditions_link: nil, type: nil, upstream_cnp_id: nil, use_cases: nil)
+        #   @param billed_date [Time, nil]
+        #   @param brand_id [String, nil]
+        #   @param cost [Float, nil]
+        #   @param csp_id [String, nil]
+        #   @param customer_id [String]
+        #   @param description [String]
+        #   @param help_keywords [String, nil]
+        #   @param help_message [String, nil]
+        #   @param kyc_submission_form_id [String, nil]
+        #   @param message_flow [String, nil]
+        #   @param name [String]
+        #   @param optin_keywords [String, nil]
+        #   @param optin_message [String, nil]
+        #   @param optout_keywords [String, nil]
+        #   @param optout_message [String, nil]
+        #   @param privacy_policy_link [String, nil]
+        #   @param reseller_id [String, nil]
+        #   @param sharing_status [Symbol, Sentdm::Models::Brands::TcrCampaignWithUseCases::SharingStatus, nil]
+        #   @param status [Symbol, Sentdm::Models::Brands::TcrCampaignWithUseCases::Status, nil]
+        #   @param submitted_at [Time, nil]
+        #   @param submitted_to_tcr [Boolean]
+        #   @param tcr_campaign_id [String, nil]
+        #   @param tcr_sync_error [String, nil]
+        #   @param telnyx_campaign_id [String, nil]
+        #   @param terms_and_conditions_link [String, nil]
+        #   @param type [String]
+        #   @param upstream_cnp_id [String, nil]
+        #   @param use_cases [Array<Sentdm::Models::Brands::TcrCampaignWithUseCases::UseCase>]
+
+        module SharingStatus
+          extend Sentdm::Internal::Type::Enum
+
+          PENDING = :PENDING
+          ACCEPTED = :ACCEPTED
+          DECLINED = :DECLINED
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        module Status
+          extend Sentdm::Internal::Type::Enum
+
+          SENT_CREATED = :SENT_CREATED
+          ACTIVE = :ACTIVE
+          EXPIRED = :EXPIRED
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        class UseCase < Sentdm::Models::Brands::BaseDto
+          # @!attribute campaign_id
+          #
+          #   @return [String, nil]
+          optional :campaign_id, String, api_name: :campaignId
+
+          # @!attribute customer_id
+          #
+          #   @return [String, nil]
+          optional :customer_id, String, api_name: :customerId
+
+          # @!attribute messaging_use_case_us
+          #
+          #   @return [Symbol, Sentdm::Models::Brands::MessagingUseCaseUs, nil]
+          optional :messaging_use_case_us,
+                   enum: -> { Sentdm::Brands::MessagingUseCaseUs },
+                   api_name: :messagingUseCaseUs
+
+          # @!attribute sample_messages
+          #
+          #   @return [Array<String>, nil]
+          optional :sample_messages, Sentdm::Internal::Type::ArrayOf[String], api_name: :sampleMessages
+
+          # @!method initialize(campaign_id: nil, customer_id: nil, messaging_use_case_us: nil, sample_messages: nil)
+          #   @param campaign_id [String]
+          #   @param customer_id [String]
+          #   @param messaging_use_case_us [Symbol, Sentdm::Models::Brands::MessagingUseCaseUs]
+          #   @param sample_messages [Array<String>]
+        end
+      end
+    end
+  end
+end

data/lib/sentdm/models/contact.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class Contact < Sentdm::Internal::Type::BaseModel
+      # @!attribute id
+      #   Unique identifier for the contact
+      #
+      #   @return [String, nil]
+      optional :id, String
+
+      # @!attribute available_channels
+      #   Comma-separated list of available messaging channels (e.g., "sms,whatsapp")
+      #
+      #   @return [String, nil]
+      optional :available_channels, String
+
+      # @!attribute country_code
+      #   Country calling code (e.g., 1 for US/Canada)
+      #
+      #   @return [String, nil]
+      optional :country_code, String
+
+      # @!attribute created_at
+      #   When the contact was created
+      #
+      #   @return [Time, nil]
+      optional :created_at, Time
+
+      # @!attribute default_channel
+      #   Default messaging channel to use (e.g., "sms" or "whatsapp")
+      #
+      #   @return [String, nil]
+      optional :default_channel, String
+
+      # @!attribute format_e164
+      #   Phone number in E.164 format (e.g., +1234567890)
+      #
+      #   @return [String, nil]
+      optional :format_e164, String
+
+      # @!attribute format_international
+      #   Phone number in international format (e.g., +1 234-567-890)
+      #
+      #   @return [String, nil]
+      optional :format_international, String
+
+      # @!attribute format_national
+      #   Phone number in national format (e.g., (234) 567-890)
+      #
+      #   @return [String, nil]
+      optional :format_national, String
+
+      # @!attribute format_rfc
+      #   Phone number in RFC 3966 format (e.g., tel:+1-234-567-890)
+      #
+      #   @return [String, nil]
+      optional :format_rfc, String
+
+      # @!attribute is_inherited
+      #   Whether this is an inherited contact (read-only)
+      #
+      #   @return [Boolean, nil]
+      optional :is_inherited, Sentdm::Internal::Type::Boolean
+
+      # @!attribute opt_out
+      #   Whether the contact has opted out of messaging
+      #
+      #   @return [Boolean, nil]
+      optional :opt_out, Sentdm::Internal::Type::Boolean
+
+      # @!attribute phone_number
+      #   Phone number in original format
+      #
+      #   @return [String, nil]
+      optional :phone_number, String
+
+      # @!attribute region_code
+      #   ISO 3166-1 alpha-2 country code (e.g., US, CA, GB)
+      #
+      #   @return [String, nil]
+      optional :region_code, String
+
+      # @!attribute updated_at
+      #   When the contact was last updated
+      #
+      #   @return [Time, nil]
+      optional :updated_at, Time, nil?: true
+
+      # @!method initialize(id: nil, available_channels: nil, country_code: nil, created_at: nil, default_channel: nil, format_e164: nil, format_international: nil, format_national: nil, format_rfc: nil, is_inherited: nil, opt_out: nil, phone_number: nil, region_code: nil, updated_at: nil)
+      #   Contact response for v3 API Uses snake_case for JSON property names
+      #
+      #   @param id [String] Unique identifier for the contact
+      #
+      #   @param available_channels [String] Comma-separated list of available messaging channels (e.g., "sms,whatsapp")
+      #
+      #   @param country_code [String] Country calling code (e.g., 1 for US/Canada)
+      #
+      #   @param created_at [Time] When the contact was created
+      #
+      #   @param default_channel [String] Default messaging channel to use (e.g., "sms" or "whatsapp")
+      #
+      #   @param format_e164 [String] Phone number in E.164 format (e.g., +1234567890)
+      #
+      #   @param format_international [String] Phone number in international format (e.g., +1 234-567-890)
+      #
+      #   @param format_national [String] Phone number in national format (e.g., (234) 567-890)
+      #
+      #   @param format_rfc [String] Phone number in RFC 3966 format (e.g., tel:+1-234-567-890)
+      #
+      #   @param is_inherited [Boolean] Whether this is an inherited contact (read-only)
+      #
+      #   @param opt_out [Boolean] Whether the contact has opted out of messaging
+      #
+      #   @param phone_number [String] Phone number in original format
+      #
+      #   @param region_code [String] ISO 3166-1 alpha-2 country code (e.g., US, CA, GB)
+      #
+      #   @param updated_at [Time, nil] When the contact was last updated
+    end
+  end
+end

data/lib/sentdm/models/contact_create_params.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    # @see Sentdm::Resources::Contacts#create
+    class ContactCreateParams < Sentdm::Internal::Type::BaseModel
+      extend Sentdm::Internal::Type::RequestParameters::Converter
+      include Sentdm::Internal::Type::RequestParameters
+
+      # @!attribute phone_number
+      #   Phone number of the contact to create
+      #
+      #   @return [String, nil]
+      optional :phone_number, 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 idempotency_key
+      #
+      #   @return [String, nil]
+      optional :idempotency_key, String
+
+      # @!method initialize(phone_number: nil, test_mode: nil, idempotency_key: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Sentdm::Models::ContactCreateParams} for more details.
+      #
+      #   @param phone_number [String] Phone number of the contact to create
+      #
+      #   @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/contact_delete_params.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    # @see Sentdm::Resources::Contacts#delete
+    class ContactDeleteParams < Sentdm::Internal::Type::BaseModel
+      extend Sentdm::Internal::Type::RequestParameters::Converter
+      include Sentdm::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute body
+      #   Request to delete/dissociate a contact
+      #
+      #   @return [Sentdm::Models::ContactDeleteParams::Body]
+      required :body, -> { Sentdm::ContactDeleteParams::Body }
+
+      # @!method initialize(id:, body:, request_options: {})
+      #   @param id [String]
+      #
+      #   @param body [Sentdm::Models::ContactDeleteParams::Body] Request to delete/dissociate a contact
+      #
+      #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
+
+      class Body < Sentdm::Models::MutationRequest
+        # @!method initialize
+        #   Request to delete/dissociate a contact
+      end
+    end
+  end
+end

data/lib/sentdm/models/contact_list_params.rb

@@ -8,21 +8,44 @@ module Sentdm
       include Sentdm::Internal::Type::RequestParameters
 
       # @!attribute page
-      #   The page number (zero-indexed). Default is 0.
+      #   Page number (1-indexed)
       #
       #   @return [Integer]
       required :page, Integer
 
       # @!attribute page_size
-      #   The number of items per page. Default is 20.
       #
       #   @return [Integer]
       required :page_size, Integer
 
-      # @!method initialize(page:, page_size:, request_options: {})
-      #   @param page [Integer] The page number (zero-indexed). Default is 0.
+      # @!attribute channel
+      #   Optional channel filter (sms, whatsapp)
       #
-      #   @param page_size [Integer] The number of items per page. Default is 20.
+      #   @return [String, nil]
+      optional :channel, String, nil?: true
+
+      # @!attribute phone
+      #   Optional phone number filter (alternative to list view)
+      #
+      #   @return [String, nil]
+      optional :phone, String, nil?: true
+
+      # @!attribute search
+      #   Optional search term for filtering contacts
+      #
+      #   @return [String, nil]
+      optional :search, String, nil?: true
+
+      # @!method initialize(page:, page_size:, channel: nil, phone: nil, search: nil, request_options: {})
+      #   @param page [Integer] Page number (1-indexed)
+      #
+      #   @param page_size [Integer]
+      #
+      #   @param channel [String, nil] Optional channel filter (sms, whatsapp)
+      #
+      #   @param phone [String, nil] Optional phone number filter (alternative to list view)
+      #
+      #   @param search [String, nil] Optional search term for filtering contacts
       #
       #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
     end

data/lib/sentdm/models/contact_list_response.rb

@@ -4,37 +4,62 @@ module Sentdm
   module Models
     # @see Sentdm::Resources::Contacts#list
     class ContactListResponse < Sentdm::Internal::Type::BaseModel
-      # @!attribute items
+      # @!attribute data
+      #   The response data (null if error)
       #
-      #   @return [Array<Sentdm::Models::ContactListItem>, nil]
-      optional :items, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::ContactListItem] }
+      #   @return [Sentdm::Models::ContactListResponse::Data, nil]
+      optional :data, -> { Sentdm::Models::ContactListResponse::Data }, nil?: true
 
-      # @!attribute page
+      # @!attribute error
+      #   Error details (null if successful)
       #
-      #   @return [Integer, nil]
-      optional :page, Integer
+      #   @return [Sentdm::Models::APIError, nil]
+      optional :error, -> { Sentdm::APIError }, nil?: true
 
-      # @!attribute page_size
+      # @!attribute meta
+      #   Metadata about the request and response
       #
-      #   @return [Integer, nil]
-      optional :page_size, Integer, api_name: :pageSize
+      #   @return [Sentdm::Models::APIMeta, nil]
+      optional :meta, -> { Sentdm::APIMeta }
 
-      # @!attribute total_count
+      # @!attribute success
+      #   Indicates whether the request was successful
       #
-      #   @return [Integer, nil]
-      optional :total_count, Integer, api_name: :totalCount
+      #   @return [Boolean, nil]
+      optional :success, Sentdm::Internal::Type::Boolean
 
-      # @!attribute total_pages
+      # @!method initialize(data: nil, error: nil, meta: nil, success: nil)
+      #   Standard API response envelope for all v3 endpoints
       #
-      #   @return [Integer, nil]
-      optional :total_pages, Integer, api_name: :totalPages
+      #   @param data [Sentdm::Models::ContactListResponse::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::ContactListResponse#data
+      class Data < Sentdm::Internal::Type::BaseModel
+        # @!attribute contacts
+        #   List of contacts
+        #
+        #   @return [Array<Sentdm::Models::Contact>, nil]
+        optional :contacts, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::Contact] }
+
+        # @!attribute pagination
+        #   Pagination metadata
+        #
+        #   @return [Sentdm::Models::PaginationMeta, nil]
+        optional :pagination, -> { Sentdm::PaginationMeta }
 
-      # @!method initialize(items: nil, page: nil, page_size: nil, total_count: nil, total_pages: nil)
-      #   @param items [Array<Sentdm::Models::ContactListItem>]
-      #   @param page [Integer]
-      #   @param page_size [Integer]
-      #   @param total_count [Integer]
-      #   @param total_pages [Integer]
+        # @!method initialize(contacts: nil, pagination: nil)
+        #   The response data (null if error)
+        #
+        #   @param contacts [Array<Sentdm::Models::Contact>] List of contacts
+        #
+        #   @param pagination [Sentdm::Models::PaginationMeta] Pagination metadata
+      end
     end
   end
 end