sentdm 0.45.0 → 0.47.0

data/lib/sentdm/models/compliance_requirement.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class ComplianceRequirement < Sentdm::Internal::Type::BaseModel
+      # @!attribute format_
+      #   Refinement of type where the market demands a specific shape, e.g. e164, url,
+      #   email, iso3166_alpha2, csv_keywords.
+      #
+      #   @return [String, nil]
+      optional :format_, String, api_name: :format, nil?: true
+
+      # @!attribute item_fields
+      #   Shape of each entry, when this requirement is a list of objects rather than of
+      #   scalars.
+      #
+      #   The compliance value stays null in the setup body like every other blank — a
+      #   body that carries a half-filled object is one the endpoint refuses, which would
+      #   break the promise that the published body can be sent as it stands. So the shape
+      #   is described here instead, and each entry the caller composes has these keys.
+      #
+      #   @return [Array<Sentdm::Models::ComplianceRequirement>, nil]
+      optional :item_fields, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::ComplianceRequirement] }, nil?: true
+
+      # @!attribute key
+      #   Key to use in the compliance map.
+      #
+      #   @return [String, nil]
+      optional :key, String
+
+      # @!attribute label
+      #   Human label, suitable for a form field.
+      #
+      #   @return [String, nil]
+      optional :label, String, nil?: true
+
+      # @!attribute max_items
+      #   Most entries this value accepts, where the market caps it.
+      #
+      #   @return [Integer, nil]
+      optional :max_items, Integer, nil?: true
+
+      # @!attribute min_length
+      #   Shortest acceptable value, where the market sets one. TCR refuses a consent
+      #   narrative under 40 characters, and finding that out at submission time is the
+      #   round trip this exists to save.
+      #
+      #   @return [Integer, nil]
+      optional :min_length, Integer, nil?: true
+
+      # @!attribute notes
+      #   Why the market asks for this.
+      #
+      #   @return [String, nil]
+      optional :notes, String, nil?: true
+
+      # @!attribute options
+      #   Accepted values, when the type is an enum or a constrained array.
+      #
+      #   @return [Array<String>, nil]
+      optional :options, Sentdm::Internal::Type::ArrayOf[String], nil?: true
+
+      # @!attribute required
+      #   Whether the market always demands this value.
+      #
+      #   @return [Boolean, nil]
+      optional :required, Sentdm::Internal::Type::Boolean
+
+      # @!attribute required_when
+      #   Condition that makes this value required, when it is only required in some cases
+      #   — e.g. brand.entity_type == PUBLIC_PROFIT. Evaluate it against your own payload
+      #   to know whether to collect the field.
+      #
+      #   @return [String, nil]
+      optional :required_when, String, nil?: true
+
+      # @!attribute type
+      #   Value type: string, number, boolean, date, enum, object, array or document.
+      #
+      #   @return [String, nil]
+      optional :type, String
+
+      # @!method initialize(format_: nil, item_fields: nil, key: nil, label: nil, max_items: nil, min_length: nil, notes: nil, options: nil, required: nil, required_when: nil, type: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Sentdm::Models::ComplianceRequirement} for more details.
+      #
+      #   One value a market expects in a channel call's compliance map.
+      #
+      #   @param format_ [String, nil] Refinement of type where the market demands a specific shape, e.g. e164,
+      #
+      #   @param item_fields [Array<Sentdm::Models::ComplianceRequirement>, nil] Shape of each entry, when this requirement is a list of objects rather than of s
+      #
+      #   @param key [String] Key to use in the compliance map.
+      #
+      #   @param label [String, nil] Human label, suitable for a form field.
+      #
+      #   @param max_items [Integer, nil] Most entries this value accepts, where the market caps it.
+      #
+      #   @param min_length [Integer, nil] Shortest acceptable value, where the market sets one. TCR refuses a consent narr
+      #
+      #   @param notes [String, nil] Why the market asks for this.
+      #
+      #   @param options [Array<String>, nil] Accepted values, when the type is an enum or a constrained array.
+      #
+      #   @param required [Boolean] Whether the market always demands this value.
+      #
+      #   @param required_when [String, nil] Condition that makes this value required, when it is only required in some cases
+      #
+      #   @param type [String] Value type: string, number, boolean, date, enum,
+    end
+  end
+end

data/lib/sentdm/models/compliance_requirements.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class ComplianceRequirements < Sentdm::Internal::Type::BaseModel
+      # @!attribute channel
+      #   Channel the requirements apply to — sms, whatsapp or rcs.
+      #
+      #   Echoed so the document says which channel it describes. It always described one:
+      #   setup's last step is a specific channel path, and every type is an SMS sender
+      #   type — but a caller reading the payload had to infer that from the path to know
+      #   it.
+      #
+      #   @return [String, nil]
+      optional :channel, String
+
+      # @!attribute country
+      #   ISO 3166-1 alpha-2 country the requirements apply to.
+      #
+      #   @return [String, nil]
+      optional :country, String
+
+      # @!attribute required
+      #   Whether this market demands anything before a sender can be registered. When
+      #   false, the compliance array may be omitted entirely and the profile is ready
+      #   once provisioned.
+      #
+      #   @return [Boolean, nil]
+      optional :required, Sentdm::Internal::Type::Boolean
+
+      # @!attribute requirements
+      #   Values to supply in compliance. Empty when the market demands nothing. Values
+      #   Sent supplies on your behalf are never listed, and neither are ones it derives
+      #   from what you send.
+      #
+      #   @return [Array<Sentdm::Models::ComplianceRequirement>, nil]
+      optional :requirements, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::ComplianceRequirement] }
+
+      # @!attribute sender_id_pattern
+      #   Pattern the sender's own value must match, where the market dictates one —
+      #   alphanumeric sender ids and short codes. Null when the value is
+      #   carrier-assigned.
+      #
+      #   @return [String, nil]
+      optional :sender_id_pattern, String, nil?: true
+
+      # @!attribute setup
+      #   The calls that set this market up, in the order they have to be made, each
+      #   carrying a body that can be sent as it stands.
+      #
+      #   This is the answer to "what do I actually do". Requirements describes each value
+      #   the market wants; this assembles those descriptions into the requests that
+      #   supply them, so a caller — or an agent acting for one — copies a body out and
+      #   sends it rather than building one from a table.
+      #
+      #   The last step is always the channel itself, and it is where the regime's own
+      #   values are supplied. The one before it, where there is one, is the brand a
+      #   registering market files against — so it is a step of its own and the channel
+      #   call refuses until it exists. A market that registers with nobody has one step.
+      #
+      #   @return [Array<Sentdm::Models::ComplianceSetupStep>, nil]
+      optional :setup, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::ComplianceSetupStep] }
+
+      # @!attribute type
+      #   Sender type the requirements apply to.
+      #
+      #   Non-nullable while sms is the only channel answered here, because it is the only
+      #   channel whose senders have a type — the day another one is answered, this
+      #   becomes nullable along with it. Not nullable in advance: nothing can emit null
+      #   today, and publishing a shape the API never sends is the same mistake as
+      #   publishing a field it does not have.
+      #
+      #   @return [String, nil]
+      optional :type, String
+
+      # @!method initialize(channel: nil, country: nil, required: nil, requirements: nil, sender_id_pattern: nil, setup: nil, type: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Sentdm::Models::ComplianceRequirements} for more details.
+      #
+      #   Everything a market expects of a sender, for one channel, country and sender
+      #   type.
+      #
+      #   @param channel [String] Channel the requirements apply to — sms, whatsapp or rcs.
+      #
+      #   @param country [String] ISO 3166-1 alpha-2 country the requirements apply to.
+      #
+      #   @param required [Boolean] Whether this market demands anything before a sender can be registered. When fal
+      #
+      #   @param requirements [Array<Sentdm::Models::ComplianceRequirement>] Values to supply in compliance. Empty when the market demands nothing. Values Se
+      #
+      #   @param sender_id_pattern [String, nil] Pattern the sender's own value must match, where the market dictates one — alpha
+      #
+      #   @param setup [Array<Sentdm::Models::ComplianceSetupStep>] The calls that set this market up, in the order they have to be made, each carry
+      #
+      #   @param type [String] Sender type the requirements apply to.
+    end
+  end
+end

data/lib/sentdm/models/compliance_retrieve_requirements_params.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    # @see Sentdm::Resources::Compliance#retrieve_requirements
+    class ComplianceRetrieveRequirementsParams < Sentdm::Internal::Type::BaseModel
+      extend Sentdm::Internal::Type::RequestParameters::Converter
+      include Sentdm::Internal::Type::RequestParameters
+
+      # @!attribute channel
+      #   Channel the sender is for: sms, whatsapp or rcs. Defaults to sms, which is the
+      #   only one answered today — the other two are 501 until their requirements are
+      #   declared.
+      #
+      #   @return [String, nil]
+      optional :channel, String, nil?: true
+
+      # @!attribute country
+      #   ISO 3166-1 alpha-2 country code, e.g. US, XK, IN
+      #
+      #   @return [String, nil]
+      optional :country, String, nil?: true
+
+      # @!attribute type
+      #   Sender type: LOCAL, MOBILE, TEN_DLC, TOLL_FREE, SHORT_CODE, ALPHANUMERIC. 10DLC
+      #   is accepted as a synonym of TEN_DLC, the same as on POST /v3/sender-profiles.
+      #   Applies to channel=sms, the only channel whose senders have a type.
+      #
+      #   @return [String, nil]
+      optional :type, String, nil?: true
+
+      # @!attribute x_profile_id
+      #
+      #   @return [String, nil]
+      optional :x_profile_id, String
+
+      # @!method initialize(channel: nil, country: nil, type: nil, x_profile_id: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Sentdm::Models::ComplianceRetrieveRequirementsParams} for more details.
+      #
+      #   @param channel [String, nil] Channel the sender is for: sms, whatsapp or rcs. Defaults to sms, which is the o
+      #
+      #   @param country [String, nil] ISO 3166-1 alpha-2 country code, e.g. US, XK, IN
+      #
+      #   @param type [String, nil] Sender type: LOCAL, MOBILE, TEN_DLC, TOLL_FREE, SHORT_CODE, ALPHANUMERIC. 10DLC
+      #
+      #   @param x_profile_id [String]
+      #
+      #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/sentdm/models/compliance_setup_step.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class ComplianceSetupStep < Sentdm::Internal::Type::BaseModel
+      # @!attribute attachments
+      #   Files to attach as multipart, when this call takes any. Absent when it does not.
+      #
+      #   @return [Array<Sentdm::Models::ComplianceAttachmentTemplate>, nil]
+      optional :attachments,
+               -> { Sentdm::Internal::Type::ArrayOf[Sentdm::ComplianceAttachmentTemplate] },
+               nil?: true
+
+      # @!attribute body
+      #   The request body, with every key this market wants already present and the
+      #   values left blank. Send it as it stands and the response names each blank that
+      #   still has to be filled.
+      #
+      #   @return [Object, nil]
+      optional :body, Sentdm::Internal::Type::Unknown
+
+      # @!attribute method_
+      #
+      #   @return [String, nil]
+      optional :method_, String, api_name: :method
+
+      # @!attribute path
+      #   Path to call. Add the x-profile-id header with an organization key to make the
+      #   same call for one of your sender profiles — there is no separate path for that.
+      #
+      #   @return [String, nil]
+      optional :path, String
+
+      # @!attribute resource
+      #   What this call sets up: brand or channel.
+      #
+      #   @return [String, nil]
+      optional :resource, String
+
+      # @!attribute step
+      #   Position in the sequence, from 1. Steps must be performed in this order.
+      #
+      #   @return [Integer, nil]
+      optional :step, Integer
+
+      # @!attribute why
+      #   Why this market needs this call, in one sentence.
+      #
+      #   @return [String, nil]
+      optional :why, String
+
+      # @!method initialize(attachments: nil, body: nil, method_: nil, path: nil, resource: nil, step: nil, why: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Sentdm::Models::ComplianceSetupStep} for more details.
+      #
+      #   One call to make, with a body that can be sent as it stands.
+      #
+      #   The steps are ordered and the order is load-bearing: a channel that registers
+      #   with a regime is filed against a brand, so the brand call comes first and the
+      #   channel call refuses until it has been made. Doing them in order is the whole of
+      #   setting a market up.
+      #
+      #   @param attachments [Array<Sentdm::Models::ComplianceAttachmentTemplate>, nil] Files to attach as multipart, when this call takes any. Absent when it does not.
+      #
+      #   @param body [Object] The request body, with every key this market wants already present and the value
+      #
+      #   @param method_ [String]
+      #
+      #   @param path [String] Path to call. Add the x-profile-id header with an organization key to make the s
+      #
+      #   @param resource [String] What this call sets up: brand or channel.
+      #
+      #   @param step [Integer] Position in the sequence, from 1. Steps must be performed in this order.
+      #
+      #   @param why [String] Why this market needs this call, in one sentence.
+    end
+  end
+end

data/lib/sentdm/models/contact_message_summary.rb

@@ -5,9 +5,8 @@ module Sentdm
     class ContactMessageSummary < Sentdm::Internal::Type::BaseModel
       # @!attribute channel_scores
       #
-      #   @return [Array<Sentdm::Models::ContactMessageSummary::ChannelScore>, nil]
-      optional :channel_scores,
-               -> { Sentdm::Internal::Type::ArrayOf[Sentdm::ContactMessageSummary::ChannelScore] }
+      #   @return [Array<Sentdm::Models::ChannelScore>, nil]
+      optional :channel_scores, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::ChannelScore] }
 
       # @!attribute channels_used
       #
@@ -35,42 +34,12 @@ module Sentdm
       optional :message_count, Integer
 
       # @!method initialize(channel_scores: nil, channels_used: nil, contact_id: nil, first_message_at: nil, last_message_at: nil, message_count: nil)
-      #   @param channel_scores [Array<Sentdm::Models::ContactMessageSummary::ChannelScore>]
+      #   @param channel_scores [Array<Sentdm::Models::ChannelScore>]
       #   @param channels_used [Array<String>]
       #   @param contact_id [String]
       #   @param first_message_at [Time, nil]
       #   @param last_message_at [Time, nil]
       #   @param message_count [Integer]
-
-      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::ContactMessageSummary::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
 end

data/lib/sentdm/models/contacts_list.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class ContactsList < Sentdm::Internal::Type::BaseModel
+      # @!attribute contacts
+      #   The contacts on this page.
+      #
+      #   @return [Array<Sentdm::Models::ContactResponse>, nil]
+      optional :contacts, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::ContactResponse] }
+
+      # @!attribute pagination
+      #   Pagination metadata for list responses
+      #
+      #   @return [Sentdm::Models::PaginationMeta, nil]
+      optional :pagination, -> { Sentdm::PaginationMeta }
+
+      # @!method initialize(contacts: nil, pagination: nil)
+      #   A paginated list of contacts.
+      #
+      #   @param contacts [Array<Sentdm::Models::ContactResponse>] The contacts on this page.
+      #
+      #   @param pagination [Sentdm::Models::PaginationMeta] Pagination metadata for list responses
+    end
+  end
+end