sentdm 0.45.0 → 0.46.0

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

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Channels
+      class SMSNumber < Sentdm::Internal::Type::BaseModel
+        # @!attribute area_code
+        #   The number's area code, e.g. 212. While the number is still to be assigned, the
+        #   area code it was asked for, or null when it was asked for in any area code.
+        #
+        #   @return [String, nil]
+        optional :area_code, String, nil?: true
+
+        # @!attribute sender_value
+        #   The number, or null while it is still to be assigned.
+        #
+        #   @return [String, nil]
+        optional :sender_value, String, nil?: true
+
+        # @!attribute status
+        #   ACTIVE once the number can send; PROVISIONING while it is still to be assigned;
+        #   INACTIVE once it could send and no longer can.
+        #
+        #   @return [String, nil]
+        optional :status, String, nil?: true
+
+        # @!method initialize(area_code: nil, sender_value: nil, status: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Sentdm::Models::Channels::SMSNumber} for more details.
+        #
+        #   One number of an SMS market.
+        #
+        #   @param area_code [String, nil] The number's area code, e.g. 212. While the number is still to be assigned, the
+        #
+        #   @param sender_value [String, nil] The number, or null while it is still to be assigned.
+        #
+        #   @param status [String, nil] ACTIVE once the number can send; PROVISIONING while it is still to be assigned;
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Channels
+      class SMSNumberRequest < Sentdm::Internal::Type::BaseModel
+        # @!attribute area_code
+        #   The area code, e.g. 212, validated against the request's country. Omit it for
+        #   numbers in any area code.
+        #
+        #   @return [String, nil]
+        optional :area_code, String, nil?: true
+
+        # @!attribute quantity
+        #   How many numbers. At least 1; omitted means 1.
+        #
+        #   @return [Integer, nil]
+        optional :quantity, Integer, nil?: true
+
+        # @!method initialize(area_code: nil, quantity: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Sentdm::Models::Channels::SMSNumberRequest} for more details.
+        #
+        #   One entry of numbers: how many numbers to assign in one area code, or in any
+        #   area code when AreaCode is omitted.
+        #
+        #   @param area_code [String, nil] The area code, e.g. 212, validated against the request's country. Omit it for nu
+        #
+        #   @param quantity [Integer, nil] How many numbers. At least 1; omitted means 1.
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Channels
+      # @see Sentdm::Resources::Channels::SMS#update
+      class SMSUpdateParams < Sentdm::Internal::Type::BaseModel
+        extend Sentdm::Internal::Type::RequestParameters::Converter
+        include Sentdm::Internal::Type::RequestParameters
+
+        # @!attribute country
+        #
+        #   @return [String]
+        required :country, String
+
+        # @!attribute type
+        #
+        #   @return [String]
+        required :type, String
+
+        # @!attribute compliance
+        #   The compliance values a market registers with. `brand` and `campaign` apply to
+        #   US `TEN_DLC`; other markets fill this map with the document keys their own
+        #   requirements name.
+        #
+        #   @return [Sentdm::Models::Channels::MarketCompliance, nil]
+        optional :compliance, -> { Sentdm::Channels::MarketCompliance }
+
+        # @!attribute sandbox
+        #
+        #   @return [Boolean, nil]
+        optional :sandbox, Sentdm::Internal::Type::Boolean
+
+        # @!attribute idempotency_key
+        #
+        #   @return [String, nil]
+        optional :idempotency_key, String
+
+        # @!attribute x_profile_id
+        #
+        #   @return [String, nil]
+        optional :x_profile_id, String
+
+        # @!method initialize(country:, type:, compliance: nil, sandbox: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Sentdm::Models::Channels::SMSUpdateParams} for more details.
+        #
+        #   @param country [String]
+        #
+        #   @param type [String]
+        #
+        #   @param compliance [Sentdm::Models::Channels::MarketCompliance] The compliance values a market registers with. `brand` and `campaign` apply to U
+        #
+        #   @param sandbox [Boolean]
+        #
+        #   @param idempotency_key [String]
+        #
+        #   @param x_profile_id [String]
+        #
+        #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Channels
+      class SuppliedCompliance < 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::Channels::SuppliedDocument>, nil]
+        optional :documents,
+                 -> { Sentdm::Internal::Type::ArrayOf[Sentdm::Channels::SuppliedDocument] },
+                 nil?: true
+
+        # @!method initialize(brand: nil, campaign: nil, documents: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Sentdm::Models::Channels::SuppliedCompliance} 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::Channels::SuppliedDocument>, nil] What has been supplied for this market.
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Channels
+      class SuppliedDocument < 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

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

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Channels
+      class WhatsappChannel < Sentdm::Internal::Type::BaseModel
+        # @!attribute owner_business_id
+        #   Derived from the organization's shared-account listing, like SolutionId.
+        #
+        #   @return [String, nil]
+        optional :owner_business_id, String, nil?: true
+
+        # @!attribute phone_number_id
+        #   The Meta phone-number id the profile sends from, or null when the account is
+        #   connected but no number has been named yet — which is what a provisioning status
+        #   means here.
+        #
+        #   @return [String, nil]
+        optional :phone_number_id, String, nil?: true
+
+        # @!attribute reason
+        #   A sentence for reason_code, saying what to do where it is yours. Omitted while
+        #   ACTIVE.
+        #
+        #   @return [String, nil]
+        optional :reason, String, nil?: true
+
+        # @!attribute reason_code
+        #   Why the account is not ACTIVE, as a stable code: an ErrorCodes CHANNEL_xxx value
+        #   such as CHANNEL_001 (something you owe) or CHANNEL_009 (under review). Switch on
+        #   this rather than on reason. Omitted while ACTIVE. Read-only; when nothing more
+        #   specific is known it is the generic reason for the status.
+        #
+        #   @return [String, nil]
+        optional :reason_code, String, nil?: true
+
+        # @!attribute solution_id
+        #   Derived, not echoed. The request no longer accepts this — it is read off the
+        #   organization's shared-account listing at connect time and reported back so a
+        #   caller can see which partnership the account actually arrived through.
+        #
+        #   @return [String, nil]
+        optional :solution_id, String, nil?: true
+
+        # @!attribute status
+        #   Read-only. Never carries a token — the row holds that and it is not returned.
+        #   ACTION_NEEDED when no account is connected or the account has no phone number:
+        #   both are yours to do.
+        #
+        #   @return [Symbol, Sentdm::Models::Channels::WhatsappChannel::Status, nil]
+        optional :status, enum: -> { Sentdm::Channels::WhatsappChannel::Status }, nil?: true
+
+        # @!attribute waba_id
+        #
+        #   @return [String, nil]
+        optional :waba_id, String, nil?: true
+
+        # @!method initialize(owner_business_id: nil, phone_number_id: nil, reason: nil, reason_code: nil, solution_id: nil, status: nil, waba_id: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Sentdm::Models::Channels::WhatsappChannel} for more details.
+        #
+        #   The profile's WhatsApp account. Its status is Meta's verification state.
+        #
+        #   @param owner_business_id [String, nil] Derived from the organization's shared-account listing, like SolutionId.
+        #
+        #   @param phone_number_id [String, nil] The Meta phone-number id the profile sends from, or null when the account is con
+        #
+        #   @param reason [String, nil] A sentence for reason_code, saying what to do where it is yours. Omitted while A
+        #
+        #   @param reason_code [String, nil] Why the account is not ACTIVE, as a stable code: an ErrorCodes CHANNEL_xxx value
+        #
+        #   @param solution_id [String, nil] Derived, not echoed. The request no longer accepts this — it is read off the org
+        #
+        #   @param status [Symbol, Sentdm::Models::Channels::WhatsappChannel::Status, nil] Read-only. Never carries a token — the row holds that and it is not returned. AC
+        #
+        #   @param waba_id [String, nil]
+
+        # Read-only. Never carries a token — the row holds that and it is not returned.
+        # ACTION_NEEDED when no account is connected or the account has no phone number:
+        # both are yours to do.
+        #
+        # @see Sentdm::Models::Channels::WhatsappChannel#status
+        module Status
+          extend Sentdm::Internal::Type::Enum
+
+          # We are working on it and there is nothing for you to do — a number is being procured, or a registration is being assembled. Minutes to hours.
+          PROVISIONING = :PROVISIONING
+
+          # **Waiting on you.** Something the market asks for has not been supplied, a regulator rejected what was, or we have asked you to correct and resubmit your identity data. Nothing progresses until you act. For an SMS market, `GET /v3/channels/sms/{country}/{type}` names what it wants and `PATCH` on the same path supplies it — compliance values, documents and numbers alike.
+          ACTION_NEEDED = :ACTION_NEEDED
+
+          # With a regulator or carrier — filed, or assembled and queued for us to file — and their answer is what moves it, to `ACTIVE` or back to `ACTION_NEEDED`. Nothing on your side changes it. Days for SMS, weeks for RCS.
+          PENDING_REVIEW = :PENDING_REVIEW
+
+          # Can carry traffic now. A channel a sender profile runs on its organization's reads `ACTIVE` too — it sends, which is what the field is about.
+          ACTIVE = :ACTIVE
+
+          # **It had a working sender and no longer does** — the number was released, or the campaign it carried lapsed. Distinct from `PROVISIONING`, which means it has never sent yet: the same absence of a sender, opposite news. Sends will fail until it returns to `ACTIVE`.
+          INACTIVE = :INACTIVE
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+
+    WhatsappChannel = Channels::WhatsappChannel
+  end
+end

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

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Channels
+      # @see Sentdm::Resources::Channels::Whatsapp#create
+      class WhatsappCreateParams < Sentdm::Internal::Type::BaseModel
+        extend Sentdm::Internal::Type::RequestParameters::Converter
+        include Sentdm::Internal::Type::RequestParameters
+
+        # @!attribute phone_number_id
+        #   The Meta phone-number id of the number on WabaId, which assigns it to this
+        #   profile as the number it sends from. It is not checked against the account here,
+        #   so name the account's number; it is refused if another profile already uses it.
+        #
+        #   Optional: omit it to connect the account and settle the number later. Nothing
+        #   picks one on your behalf.
+        #
+        #   @return [String, nil]
+        optional :phone_number_id, String, nil?: true
+
+        # @!attribute sandbox
+        #   Sandbox flag - when true, the operation is simulated without side effects Useful
+        #   for testing integrations without actual execution
+        #
+        #   @return [Boolean, nil]
+        optional :sandbox, Sentdm::Internal::Type::Boolean
+
+        # @!attribute waba_id
+        #   WhatsApp Business Account id — one of the accounts shared into your
+        #   organization. Required: the organization holds one per client, and nothing but
+        #   the caller says which is meant here.
+        #
+        #   @return [String, nil]
+        optional :waba_id, String
+
+        # @!attribute idempotency_key
+        #
+        #   @return [String, nil]
+        optional :idempotency_key, String
+
+        # @!attribute x_profile_id
+        #
+        #   @return [String, nil]
+        optional :x_profile_id, String
+
+        # @!method initialize(phone_number_id: nil, sandbox: nil, waba_id: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Sentdm::Models::Channels::WhatsappCreateParams} for more details.
+        #
+        #   @param phone_number_id [String, nil] The Meta phone-number id of the number on WabaId, which assigns it to this profi
+        #
+        #   @param sandbox [Boolean] Sandbox flag - when true, the operation is simulated without side effects
+        #
+        #   @param waba_id [String] WhatsApp Business Account id — one of the accounts shared into your organization
+        #
+        #   @param idempotency_key [String]
+        #
+        #   @param x_profile_id [String]
+        #
+        #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/sentdm/models/channels_state.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class ChannelsState < Sentdm::Internal::Type::BaseModel
+      # @!attribute customer_id
+      #   Which customer these channels belong to — the key's own, or the profile named in
+      #   x-profile-id.
+      #
+      #   Same reason the brand carries one: as the response to /v3/channels there is no
+      #   other id in the document, and under x-profile-id this is the profile the call
+      #   resolved to rather than the caller. Absent when nested inside a sender profile,
+      #   whose own id already says whose they are.
+      #
+      #   @return [String, nil]
+      optional :customer_id, String, nil?: true
+
+      # @!attribute mms
+      #   The markets this profile can send MMS in, one entry per country, or empty when
+      #   none.
+      #
+      #   Appears alongside sms rather than replacing an entry in it: the two are separate
+      #   senders on the same number and a caller needs to see both — a market can be live
+      #   for SMS while its MMS row is still provisioning, or MMS-incapable entirely
+      #   because the market's sender-type SKU does not carry it.
+      #
+      #   @return [Array<Sentdm::Models::MmsMarket>, nil]
+      optional :mms, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::MmsMarket] }
+
+      # @!attribute rcs
+      #   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 :rcs, -> { Sentdm::Channels::RcsAgent }, nil?: true
+
+      # @!attribute sms
+      #
+      #   @return [Array<Sentdm::Models::Channels::SMSMarket>, nil]
+      optional :sms, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::Channels::SMSMarket] }
+
+      # @!attribute voice
+      #   The numbers this profile carries phone calls on, one entry per number, or empty
+      #   when none. Voice is per number like an SMS market is per country: each number is
+      #   its own channel row, turned on and off on its own, and one of them is the line
+      #   app-originated calls fall back to.
+      #
+      #   @return [Array<Sentdm::Models::Channels::VoiceNumber>, nil]
+      optional :voice, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::Channels::VoiceNumber] }
+
+      # @!attribute whatsapp
+      #   The profile's WhatsApp account. Its status is Meta's verification state.
+      #
+      #   @return [Sentdm::Models::Channels::WhatsappChannel, nil]
+      optional :whatsapp, -> { Sentdm::Channels::WhatsappChannel }, nil?: true
+
+      # @!method initialize(customer_id: nil, mms: nil, rcs: nil, sms: nil, voice: nil, whatsapp: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Sentdm::Models::ChannelsState} for more details.
+      #
+      #   The channels a profile sends on. SMS is a list because a profile can send in
+      #   several markets; WhatsApp and RCS are single, because a profile has one business
+      #   account and one agent.
+      #
+      #   @param customer_id [String, nil] Which customer these channels belong to — the key's own, or the profile named in
+      #
+      #   @param mms [Array<Sentdm::Models::MmsMarket>] The markets this profile can send MMS in, one entry per country, or empty when n
+      #
+      #   @param rcs [Sentdm::Models::Channels::RcsAgent, nil] An RCS agent as its owner sees it: the order form back, plus where the submissio
+      #
+      #   @param sms [Array<Sentdm::Models::Channels::SMSMarket>]
+      #
+      #   @param voice [Array<Sentdm::Models::Channels::VoiceNumber>] The numbers this profile carries phone calls on, one entry per number, or empty
+      #
+      #   @param whatsapp [Sentdm::Models::Channels::WhatsappChannel, nil] The profile's WhatsApp account. Its status is Meta's verification state.
+    end
+  end
+end

data/lib/sentdm/models/compliance_attachment_template.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class ComplianceAttachmentTemplate < Sentdm::Internal::Type::BaseModel
+      # @!attribute field_name
+      #   The multipart field name to attach the file under.
+      #
+      #   @return [String, nil]
+      optional :field_name, String
+
+      # @!attribute label
+      #
+      #   @return [String, nil]
+      optional :label, String, nil?: true
+
+      # @!attribute required
+      #
+      #   @return [Boolean, nil]
+      optional :required, Sentdm::Internal::Type::Boolean
+
+      # @!method initialize(field_name: nil, label: nil, required: nil)
+      #   A file this market wants, and the multipart field to send it as.
+      #
+      #   Separate from compliance because a file is not JSON: the channel call accepts
+      #   multipart, and each file is named after the key it satisfies. Listing documents
+      #   among the JSON entries would describe a request nobody could send.
+      #
+      #   @param field_name [String] The multipart field name to attach the file under.
+      #
+      #   @param label [String, nil]
+      #
+      #   @param required [Boolean]
+    end
+  end
+end