sentdm 0.45.0 → 0.46.0

data/lib/sentdm/models/brand_with_kyc.rb

@@ -0,0 +1,129 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class BrandWithKYC < Sentdm::Internal::Type::BaseModel
+      # @!attribute id
+      #   Unique identifier for the brand
+      #
+      #   @return [String, nil]
+      optional :id, String
+
+      # @!attribute business
+      #   Business details and address information
+      #
+      #   @return [Sentdm::Models::BrandBusiness, nil]
+      optional :business, -> { Sentdm::BrandBusiness }, nil?: true
+
+      # @!attribute compliance
+      #   Compliance and TCR-related information
+      #
+      #   @return [Sentdm::Models::BrandCompliance, nil]
+      optional :compliance, -> { Sentdm::BrandCompliance }, nil?: true
+
+      # @!attribute contact
+      #   Contact information for the brand
+      #
+      #   @return [Sentdm::Models::BrandContact, nil]
+      optional :contact, -> { Sentdm::BrandContact }, nil?: true
+
+      # @!attribute created_at
+      #   When the brand was created
+      #
+      #   @return [Time, nil]
+      optional :created_at, Time
+
+      # @!attribute csp_id
+      #   @deprecated
+      #
+      #   Deprecated and scheduled for removal. Identifies the Campaign Service Provider
+      #   that registered the brand, which is Sent, so the value is the same for every
+      #   brand and every account. Nothing on your side can act on it and there is no
+      #   replacement. Stop reading it.
+      #
+      #   @return [String, nil]
+      optional :csp_id, String, nil?: true
+
+      # @!attribute identity_status
+      #
+      #   @return [Symbol, Sentdm::Models::TcrBrandIdentityStatus, nil]
+      optional :identity_status, enum: -> { Sentdm::TcrBrandIdentityStatus }, nil?: true
+
+      # @!attribute is_inherited
+      #   Whether this brand is inherited from the parent organization
+      #
+      #   @return [Boolean, nil]
+      optional :is_inherited, Sentdm::Internal::Type::Boolean
+
+      # @!attribute status
+      #
+      #   @return [Symbol, Sentdm::Models::TcrBrandStatus, nil]
+      optional :status, enum: -> { Sentdm::TcrBrandStatus }, nil?: true
+
+      # @!attribute submitted_at
+      #   When the brand was submitted to TCR
+      #
+      #   @return [Time, nil]
+      optional :submitted_at, Time, nil?: true
+
+      # @!attribute submitted_to_tcr
+      #   Whether this brand has been submitted to TCR
+      #
+      #   @return [Boolean, nil]
+      optional :submitted_to_tcr, Sentdm::Internal::Type::Boolean
+
+      # @!attribute tcr_brand_id
+      #   TCR brand ID (populated after TCR submission)
+      #
+      #   @return [String, nil]
+      optional :tcr_brand_id, String, nil?: true
+
+      # @!attribute universal_ein
+      #   Universal EIN from TCR
+      #
+      #   @return [String, nil]
+      optional :universal_ein, String, nil?: true
+
+      # @!attribute updated_at
+      #   When the brand was last updated
+      #
+      #   @return [Time, nil]
+      optional :updated_at, Time, nil?: true
+
+      # @!method initialize(id: nil, business: nil, compliance: nil, contact: nil, created_at: nil, csp_id: nil, identity_status: nil, is_inherited: nil, status: nil, submitted_at: nil, submitted_to_tcr: nil, tcr_brand_id: nil, universal_ein: nil, updated_at: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Sentdm::Models::BrandWithKYC} for more details.
+      #
+      #   Brand response with nested contact, business, and compliance sections — mirrors
+      #   the request structure.
+      #
+      #   @param id [String] Unique identifier for the brand
+      #
+      #   @param business [Sentdm::Models::BrandBusiness, nil] Business details and address information
+      #
+      #   @param compliance [Sentdm::Models::BrandCompliance, nil] Compliance and TCR-related information
+      #
+      #   @param contact [Sentdm::Models::BrandContact, nil] Contact information for the brand
+      #
+      #   @param created_at [Time] When the brand was created
+      #
+      #   @param csp_id [String, nil] Deprecated and scheduled for removal. Identifies the Campaign Service Provider t
+      #
+      #   @param identity_status [Symbol, Sentdm::Models::TcrBrandIdentityStatus, nil]
+      #
+      #   @param is_inherited [Boolean] Whether this brand is inherited from the parent organization
+      #
+      #   @param status [Symbol, Sentdm::Models::TcrBrandStatus, nil]
+      #
+      #   @param submitted_at [Time, nil] When the brand was submitted to TCR
+      #
+      #   @param submitted_to_tcr [Boolean] Whether this brand has been submitted to TCR
+      #
+      #   @param tcr_brand_id [String, nil] TCR brand ID (populated after TCR submission)
+      #
+      #   @param universal_ein [String, nil] Universal EIN from TCR
+      #
+      #   @param updated_at [Time, nil] When the brand was last updated
+    end
+  end
+end

data/lib/sentdm/models/cancelled_message.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class CancelledMessage < Sentdm::Models::Message
+      # @!attribute scheduled_at
+      #   The send time that was called off, in UTC — the scheduled_at the message was
+      #   being held for, whether you set it or the recipient's quiet hours moved it
+      #   there. Omitted only for a held message that carried no recorded instant.
+      #
+      #   @return [Time, nil]
+      optional :scheduled_at, Time, nil?: true
+
+      # @!method initialize(scheduled_at: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Sentdm::Models::CancelledMessage} for more details.
+      #
+      #   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.
+      #
+      #   @param scheduled_at [Time, nil] The send time that was called off, in UTC — the scheduled_at the message was bei
+    end
+  end
+end

data/lib/sentdm/models/channel_event_payload.rb

@@ -50,8 +50,8 @@ module Sentdm
       #   only when the market registers with nobody and compliance was not computed —
       #   nothing to show at all.
       #
-      #   @return [Sentdm::Models::ChannelEventPayload::Compliance, nil]
-      optional :compliance, -> { Sentdm::ChannelEventPayload::Compliance }, nil?: true
+      #   @return [Sentdm::Models::Channels::SuppliedCompliance, nil]
+      optional :compliance, -> { Sentdm::Channels::SuppliedCompliance }, nil?: true
 
       # @!attribute number_type
       #   The kind of sender the market uses, for example TEN_DLC, LOCAL, or ALPHANUMERIC.
@@ -146,7 +146,7 @@ module Sentdm
       #
       #   @param channel [String] The channel this market belongs to: sms, whatsapp, or rcs. Never
       #
-      #   @param compliance [Sentdm::Models::ChannelEventPayload::Compliance, nil] What a market has been given: the identity it registers under, its programme, an
+      #   @param compliance [Sentdm::Models::Channels::SuppliedCompliance, nil] What a market has been given: the identity it registers under, its programme, an
       #
       #   @param number_type [String, nil] The kind of sender the market uses, for example TEN_DLC, LOCAL, or
       #
@@ -159,117 +159,6 @@ module Sentdm
       #   @param status [String] Where the market stands: PENDING_REVIEW, ACTION_NEEDED, PROVISIONING,
       #
       #   @param updated_at [String] When the transition happened, in UTC (yyyy-MM-ddTHH:mm:ssZ).
-
-      # @see Sentdm::Models::ChannelEventPayload#compliance
-      class Compliance < Sentdm::Internal::Type::BaseModel
-        # @!attribute brand
-        #   The identity this market registers under, with inherit saying whose it is.
-        #
-        #   Reported here rather than on the profile because it belongs to the registration
-        #   this market files, and only one market files one. It was a top-level block for a
-        #   while, which put a per-registration value beside a list of markets and left a
-        #   caller to work out which market it belonged to.
-        #
-        #   Absent for a market that registers with nobody — such a market asks for no
-        #   identity, so there is none to report. Absent and null mean different things:
-        #   absent says this market does not ask, null would say it asks and nothing was
-        #   supplied.
-        #
-        #   Untyped, like the request side, because its members are declared by the market's
-        #   own schema rather than by a C# class. A typed pair here would be a second
-        #   definition of what a market wants, free to drift from the one that validates.
-        #
-        #   @return [Hash{Symbol=>Object}, nil]
-        optional :brand, Sentdm::Internal::Type::HashOf[Sentdm::Internal::Type::Unknown], nil?: true
-
-        # @!attribute campaign
-        #   The programme this market registers, with inherit saying whose it is.
-        #
-        #   One, not a list. TcrCampaigns permits several and an account built on the admin
-        #   side may hold them, but this surface offers one — which is what lets the
-        #   market's PATCH be an upsert rather than a collection with an addressable create
-        #   behind it. An account holding several is reported as its first and refused on
-        #   write, rather than half-edited.
-        #
-        #   Carries no id. Nothing addresses a campaign, and an undeclared key would be
-        #   refused if the caller sent this object back — which it is meant to be able to
-        #   do.
-        #
-        #   @return [Hash{Symbol=>Object}, nil]
-        optional :campaign, Sentdm::Internal::Type::HashOf[Sentdm::Internal::Type::Unknown], nil?: true
-
-        # @!attribute documents
-        #   What has been supplied for this market.
-        #
-        #   Files, not values — the declared halves above carry the values. A document
-        #   cannot be a JSON value, so it is sent as multipart on the channel call and
-        #   reported here as a reference.
-        #
-        #   Absent on a list read, which fetches identity but does not compute compliance
-        #   documents per market. Absent and empty mean different things: absent says the
-        #   documents were not fetched; empty says the market has been given none.
-        #
-        #   @return [Array<Sentdm::Models::ChannelEventPayload::Compliance::Document>, nil]
-        optional :documents,
-                 -> { Sentdm::Internal::Type::ArrayOf[Sentdm::ChannelEventPayload::Compliance::Document] },
-                 nil?: true
-
-        # @!method initialize(brand: nil, campaign: nil, documents: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {Sentdm::Models::ChannelEventPayload::Compliance} for more details.
-        #
-        #   What a market has been given: the identity it registers under, its programme,
-        #   and any documents attached.
-        #
-        #   What it does not carry is what the market asks for. That is the subject of GET
-        #   /v3/compliance/requirements, and it is the same answer for every caller — a
-        #   description of what a compliance regime wants, not a record of one customer's
-        #   progress through it. It was reported here as well for a while, which put the
-        #   same array in six response shapes and left a caller deciding which of two
-        #   sources to believe.
-        #
-        #   Present on a list read for markets that register (carrying brand and campaign),
-        #   but with documents absent — documents are not fetched for a list, because a
-        #   catalog lookup and a document read per market would multiply across a page.
-        #   Absent documents is distinct from an empty list: absent says they were not
-        #   fetched; empty says the market has been given none. The parent object is null
-        #   only when the market registers with nobody and compliance was not computed —
-        #   nothing to show at all.
-        #
-        #   @param brand [Hash{Symbol=>Object}, nil] The identity this market registers under, with inherit saying whose it is.
-        #
-        #   @param campaign [Hash{Symbol=>Object}, nil] The programme this market registers, with inherit saying whose it is.
-        #
-        #   @param documents [Array<Sentdm::Models::ChannelEventPayload::Compliance::Document>, nil] What has been supplied for this market.
-
-        class Document < Sentdm::Internal::Type::BaseModel
-          # @!attribute document_id
-          #   Identifier of the upload, for fetching it back through the documents endpoints.
-          #
-          #   @return [String, nil]
-          optional :document_id, String, nil?: true
-
-          # @!attribute file_name
-          #
-          #   @return [String, nil]
-          optional :file_name, String, nil?: true
-
-          # @!attribute key
-          #   The catalog's name for this document, matching the requirement it satisfies.
-          #
-          #   @return [String, nil]
-          optional :key, String
-
-          # @!method initialize(document_id: nil, file_name: nil, key: nil)
-          #   A document a market asked for and has been given.
-          #
-          #   @param document_id [String, nil] Identifier of the upload, for fetching it back through the documents endpoints.
-          #
-          #   @param file_name [String, nil]
-          #
-          #   @param key [String] The catalog's name for this document, matching the requirement it satisfies.
-        end
-      end
     end
   end
 end

data/lib/sentdm/models/channel_list_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    # @see Sentdm::Resources::Channels#list
+    class ChannelListParams < Sentdm::Internal::Type::BaseModel
+      extend Sentdm::Internal::Type::RequestParameters::Converter
+      include Sentdm::Internal::Type::RequestParameters
+
+      # @!attribute x_profile_id
+      #
+      #   @return [String, nil]
+      optional :x_profile_id, String
+
+      # @!method initialize(x_profile_id: nil, request_options: {})
+      #   @param x_profile_id [String]
+      #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/sentdm/models/channel_score.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class ChannelScore < Sentdm::Internal::Type::BaseModel
+      # @!attribute channel
+      #
+      #   @return [String, nil]
+      optional :channel, String
+
+      # @!attribute fail_score
+      #   Percentage (0-100) of messages on this channel that ended in FAILED.
+      #
+      #   @return [Integer, nil]
+      optional :fail_score, Integer
+
+      # @!attribute success_score
+      #   Percentage (0-100) of messages on this channel that reached a successful
+      #   terminal state: SENT/DELIVERED/READ for outbound, RECEIVED for inbound.
+      #
+      #   @return [Integer, nil]
+      optional :success_score, Integer
+
+      # @!method initialize(channel: nil, fail_score: nil, success_score: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Sentdm::Models::ChannelScore} for more details.
+      #
+      #   @param channel [String]
+      #
+      #   @param fail_score [Integer] Percentage (0-100) of messages on this channel that ended in FAILED.
+      #
+      #   @param success_score [Integer] Percentage (0-100) of messages on this channel that reached a successful termina
+    end
+  end
+end

data/lib/sentdm/models/channels/api_response_of_list_of_sms_market.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Channels
+      # @see Sentdm::Resources::Channels::SMS#list
+      class APIResponseOfListOfSMSMarket < Sentdm::Internal::Type::BaseModel
+        # @!attribute data
+        #   The response data (null if error)
+        #
+        #   @return [Array<Sentdm::Models::Channels::SMSMarket>, nil]
+        optional :data, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::Channels::SMSMarket] }, 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 [Array<Sentdm::Models::Channels::SMSMarket>, 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
+end

data/lib/sentdm/models/channels/api_response_of_rcs_agent.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Channels
+      # @see Sentdm::Resources::Channels::Rcs#create
+      class APIResponseOfRcsAgent < Sentdm::Internal::Type::BaseModel
+        # @!attribute data
+        #   An RCS agent as its owner sees it: the order form back, plus where the
+        #   submission stands.
+        #
+        #   Not RcsSenderResponse. That one is the admin projection and carries the pipeline
+        #   we track about a customer's request — internalStatus, statusReason, isLaunched —
+        #   and the S3 keys behind the assets. None of that is the customer's to read: an
+        #   internal status is a note to ourselves, and an S3 key is a storage detail that
+        #   would become a contract the moment it was published.
+        #
+        #   What is here is what the caller sent, in the names it sent them under, plus the
+        #   three things only we can answer: the record's id, its status, and the number it
+        #   sends from. So a read after a write shows the form as stored rather than as
+        #   echoed.
+        #
+        #   @return [Sentdm::Models::Channels::RcsAgent, nil]
+        optional :data, -> { Sentdm::Channels::RcsAgent }, 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::Channels::APIResponseOfRcsAgent} for more details.
+        #
+        #   Standard API response envelope for all v3 endpoints
+        #
+        #   @param data [Sentdm::Models::Channels::RcsAgent, nil] An RCS agent as its owner sees it: the order form back, plus where the submissio
+        #
+        #   @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
+end

data/lib/sentdm/models/channels/api_response_of_sms_market.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Channels
+      # @see Sentdm::Resources::Channels::SMS#create
+      class APIResponseOfSMSMarket < Sentdm::Internal::Type::BaseModel
+        # @!attribute data
+        #   One SMS market the profile sends in — its sender, where that sender stands, and
+        #   what the market wants.
+        #
+        #   A profile may send in several: it is a tenant, not a market. Each carries its
+        #   own status, because a profile can be live in one country and mid-registration in
+        #   another — and each carries what it still owes, rather than that being reported
+        #   in a separate array a caller has to join on.
+        #
+        #   @return [Sentdm::Models::Channels::SMSMarket, nil]
+        optional :data, -> { Sentdm::Channels::SMSMarket }, 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::Channels::APIResponseOfSMSMarket} for more details.
+        #
+        #   Standard API response envelope for all v3 endpoints
+        #
+        #   @param data [Sentdm::Models::Channels::SMSMarket, nil] One SMS market the profile sends in — its sender, where that sender stands, and
+        #
+        #   @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
+end

data/lib/sentdm/models/channels/api_response_of_whatsapp_channel.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Channels
+      # @see Sentdm::Resources::Channels::Whatsapp#create
+      class APIResponseOfWhatsappChannel < Sentdm::Internal::Type::BaseModel
+        # @!attribute data
+        #   The profile's WhatsApp account. Its status is Meta's verification state.
+        #
+        #   @return [Sentdm::Models::Channels::WhatsappChannel, nil]
+        optional :data, -> { Sentdm::Channels::WhatsappChannel }, 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::Channels::WhatsappChannel, nil] The profile's WhatsApp account. Its status is Meta's verification state.
+        #
+        #   @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
+
+    APIResponseOfWhatsappChannel = Channels::APIResponseOfWhatsappChannel
+  end
+end