sentdm 0.44.0 → 0.46.0

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

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Channels
+      class RcsAddress < Sentdm::Internal::Type::BaseModel
+        # @!attribute city
+        #
+        #   @return [String, nil]
+        optional :city, String, nil?: true
+
+        # @!attribute country
+        #
+        #   @return [String, nil]
+        optional :country, String, nil?: true
+
+        # @!attribute postal_code
+        #
+        #   @return [String, nil]
+        optional :postal_code, String, nil?: true
+
+        # @!attribute state
+        #
+        #   @return [String, nil]
+        optional :state, String, nil?: true
+
+        # @!attribute street
+        #
+        #   @return [String, nil]
+        optional :street, String, nil?: true
+
+        # @!method initialize(city: nil, country: nil, postal_code: nil, state: nil, street: nil)
+        #   The registered address of the company behind the agent.
+        #
+        #   @param city [String, nil]
+        #   @param country [String, nil]
+        #   @param postal_code [String, nil]
+        #   @param state [String, nil]
+        #   @param street [String, nil]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,278 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Channels
+      class RcsAgent < Sentdm::Internal::Type::BaseModel
+        # @!attribute id
+        #   The agent record. Stable across the whole approval, and what support will ask
+        #   for.
+        #
+        #   Nullable and omitted when absent: a sender profile with RCS intent records the
+        #   channel but has no agent until the order form is submitted, so no id exists to
+        #   report. A zero GUID is not a valid id and is worse than the field being absent.
+        #
+        #   @return [String, nil]
+        optional :id, String, nil?: true
+
+        # @!attribute agent_use_case
+        #
+        #   @return [String, nil]
+        optional :agent_use_case, String, nil?: true
+
+        # @!attribute brand_color
+        #
+        #   @return [String, nil]
+        optional :brand_color, String, nil?: true
+
+        # @!attribute brand_email
+        #
+        #   @return [String, nil]
+        optional :brand_email, String, nil?: true
+
+        # @!attribute brand_name
+        #
+        #   @return [String, nil]
+        optional :brand_name, String, nil?: true
+
+        # @!attribute brand_phone_number
+        #
+        #   @return [String, nil]
+        optional :brand_phone_number, String, nil?: true
+
+        # @!attribute brief_company_description
+        #
+        #   @return [String, nil]
+        optional :brief_company_description, String, nil?: true
+
+        # @!attribute company_ein
+        #
+        #   @return [String, nil]
+        optional :company_ein, String, nil?: true
+
+        # @!attribute contact_name_and_title
+        #
+        #   @return [String, nil]
+        optional :contact_name_and_title, String, nil?: true
+
+        # @!attribute created_at
+        #   Omitted when no real agent record exists — the intent-only path has no creation
+        #   timestamp.
+        #
+        #   @return [Time, nil]
+        optional :created_at, Time, nil?: true
+
+        # @!attribute customer_support_email
+        #
+        #   @return [String, nil]
+        optional :customer_support_email, String, nil?: true
+
+        # @!attribute customer_support_phone_number
+        #
+        #   @return [String, nil]
+        optional :customer_support_phone_number, String, nil?: true
+
+        # @!attribute description
+        #
+        #   @return [String, nil]
+        optional :description, String, nil?: true
+
+        # @!attribute display_name
+        #
+        #   @return [String, nil]
+        optional :display_name, String, nil?: true
+
+        # @!attribute entity_type
+        #
+        #   @return [String, nil]
+        optional :entity_type, String, nil?: true
+
+        # @!attribute help_message
+        #
+        #   @return [String, nil]
+        optional :help_message, String, nil?: true
+
+        # @!attribute official_address
+        #   The registered address of the company behind the agent.
+        #
+        #   @return [Sentdm::Models::Channels::RcsAddress, nil]
+        optional :official_address, -> { Sentdm::Channels::RcsAddress }, nil?: true
+
+        # @!attribute opt_in_process_description
+        #
+        #   @return [String, nil]
+        optional :opt_in_process_description, String, nil?: true
+
+        # @!attribute phone_number
+        #   The number the agent sends from, derived from brand_phone_number.
+        #
+        #   @return [String, nil]
+        optional :phone_number, String, nil?: true
+
+        # @!attribute privacy_policy_url
+        #
+        #   @return [String, nil]
+        optional :privacy_policy_url, 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 agent 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 sample_messages
+        #
+        #   @return [Array<String>, nil]
+        optional :sample_messages, Sentdm::Internal::Type::ArrayOf[String], nil?: true
+
+        # @!attribute start_message
+        #
+        #   @return [String, nil]
+        optional :start_message, String, nil?: true
+
+        # @!attribute status
+        #   Where the agent stands, in terms of who is holding it up — PROVISIONING,
+        #   ACTION_NEEDED, PENDING_REVIEW or ACTIVE.
+        #
+        #   Resolved from both of the provider's axes rather than reported raw: an agent
+        #   whose resubmission we have asked for reads ACTION_NEEDED however its carrier
+        #   status still reads, and an agent not yet handed over reads PROVISIONING rather
+        #   than pending a review nobody has started.
+        #
+        #   @return [Symbol, Sentdm::Models::Channels::RcsAgent::Status, nil]
+        optional :status, enum: -> { Sentdm::Channels::RcsAgent::Status }, nil?: true
+
+        # @!attribute stop_message
+        #
+        #   @return [String, nil]
+        optional :stop_message, String, nil?: true
+
+        # @!attribute terms_and_conditions_url
+        #
+        #   @return [String, nil]
+        optional :terms_and_conditions_url, String, nil?: true
+
+        # @!attribute website_url
+        #
+        #   @return [String, nil]
+        optional :website_url, String, nil?: true
+
+        # @!method initialize(id: nil, agent_use_case: nil, brand_color: nil, brand_email: nil, brand_name: nil, brand_phone_number: nil, brief_company_description: nil, company_ein: nil, contact_name_and_title: nil, created_at: nil, customer_support_email: nil, customer_support_phone_number: nil, description: nil, display_name: nil, entity_type: nil, help_message: nil, official_address: nil, opt_in_process_description: nil, phone_number: nil, privacy_policy_url: nil, reason: nil, reason_code: nil, sample_messages: nil, start_message: nil, status: nil, stop_message: nil, terms_and_conditions_url: nil, website_url: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Sentdm::Models::Channels::RcsAgent} for more details.
+        #
+        #   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.
+        #
+        #   @param id [String, nil] The agent record. Stable across the whole approval, and what support will ask fo
+        #
+        #   @param agent_use_case [String, nil]
+        #
+        #   @param brand_color [String, nil]
+        #
+        #   @param brand_email [String, nil]
+        #
+        #   @param brand_name [String, nil]
+        #
+        #   @param brand_phone_number [String, nil]
+        #
+        #   @param brief_company_description [String, nil]
+        #
+        #   @param company_ein [String, nil]
+        #
+        #   @param contact_name_and_title [String, nil]
+        #
+        #   @param created_at [Time, nil] Omitted when no real agent record exists — the intent-only path has no creation
+        #
+        #   @param customer_support_email [String, nil]
+        #
+        #   @param customer_support_phone_number [String, nil]
+        #
+        #   @param description [String, nil]
+        #
+        #   @param display_name [String, nil]
+        #
+        #   @param entity_type [String, nil]
+        #
+        #   @param help_message [String, nil]
+        #
+        #   @param official_address [Sentdm::Models::Channels::RcsAddress, nil] The registered address of the company behind the agent.
+        #
+        #   @param opt_in_process_description [String, nil]
+        #
+        #   @param phone_number [String, nil] The number the agent sends from, derived from brand_phone_number.
+        #
+        #   @param privacy_policy_url [String, nil]
+        #
+        #   @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 agent is not ACTIVE, as a stable code: an ErrorCodes CHANNEL_xxx value s
+        #
+        #   @param sample_messages [Array<String>, nil]
+        #
+        #   @param start_message [String, nil]
+        #
+        #   @param status [Symbol, Sentdm::Models::Channels::RcsAgent::Status, nil] Where the agent stands, in terms of who is holding it up — PROVISIONING,
+        #   ACTION\_
+        #
+        #   @param stop_message [String, nil]
+        #
+        #   @param terms_and_conditions_url [String, nil]
+        #
+        #   @param website_url [String, nil]
+
+        # Where the agent stands, in terms of who is holding it up — PROVISIONING,
+        # ACTION_NEEDED, PENDING_REVIEW or ACTIVE.
+        #
+        # Resolved from both of the provider's axes rather than reported raw: an agent
+        # whose resubmission we have asked for reads ACTION_NEEDED however its carrier
+        # status still reads, and an agent not yet handed over reads PROVISIONING rather
+        # than pending a review nobody has started.
+        #
+        # @see Sentdm::Models::Channels::RcsAgent#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
+  end
+end

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

@@ -0,0 +1,173 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Channels
+      # @see Sentdm::Resources::Channels::SMS#create
+      class SMSCreateParams < Sentdm::Internal::Type::BaseModel
+        extend Sentdm::Internal::Type::RequestParameters::Converter
+        include Sentdm::Internal::Type::RequestParameters
+
+        # @!attribute number_type
+        #   Sender type. Decides the provisioning flow and what compliance is asked for.
+        #
+        #   [Required] so the published document says so. The validator has always demanded
+        #   it, but requiredness reached the schema by matching a rule to a property name —
+        #   which works for country, whose wire name is its camel-cased C# name, and
+        #   silently does not for number_type. A client generating a request from our
+        #   OpenAPI therefore sent what the document called sufficient and was answered 400.
+        #
+        #   @return [Symbol, Sentdm::Models::Channels::SMSCreateParams::NumberType]
+        required :number_type, enum: -> { Sentdm::Channels::SMSCreateParams::NumberType }
+
+        # @!attribute area_codes
+        #   The area codes to put this sender in, in your own order of preference, e.g.
+        #   ["415", "628"] for the US or ["20"] for London. Omit it and a number is claimed
+        #   anywhere in the country.
+        #
+        #   Ordered, and the order is the request. The claim tries each code in turn and
+        #   stops at the first that yields a number. Nothing sorts the list and a code
+        #   listed twice is refused.
+        #
+        #   One to fifty entries, each the area code as digits: 415, with the trunk prefix
+        #   as 020, or with the country's dialing prefix as +1415 (all are stored as the
+        #   bare code). A dialing prefix from a different country than country is refused.
+        #   Each code is checked against the country's numbering plan: it must start real
+        #   local or mobile numbers there, so toll-free and premium ranges, service codes
+        #   and another country's codes are refused with a reason.
+        #
+        #   LOCAL senders in any country, and US TEN_DLC senders. No other sender type has a
+        #   geographic area code, and the list is refused with one rather than accepted and
+        #   dropped.
+        #
+        #   Honoured exactly or not at all. Ask for 415 and you get a 415 number or you get
+        #   none, never a neighbouring code you did not name. A miss leaves the market with
+        #   no sender yet and the codes recorded on it, so it is filled when stock appears
+        #   rather than filled now from somewhere else. Many countries outside North America
+        #   require address or business documents before a local number can be bought, which
+        #   can delay or prevent the fill.
+        #
+        #   @return [Array<String>, nil]
+        optional :area_codes, Sentdm::Internal::Type::ArrayOf[String], nil?: true
+
+        # @!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 country
+        #   ISO 3166-1 alpha-2 country the sender operates in.
+        #
+        #   @return [String, nil]
+        optional :country, String
+
+        # @!attribute numbers
+        #   The numbers to assign, one entry per area code, e.g. [{"area_code": "212",
+        #   "quantity": 2}, {"area_code": "415"}, {"quantity": 1}]: two numbers in 212, one
+        #   in 415 and one in any area code. quantity defaults to 1, and an entry without
+        #   area_code means any area code. Omit numbers for one number.
+        #
+        #   Only with LOCAL or TEN_DLC, and not together with area_codes. Each area code is
+        #   validated against country the same way area_codes is and may appear once, and at
+        #   most one entry may leave area_code out. On a LOCAL market you already hold, this
+        #   adds the numbers to it. US TEN_DLC numbers are assigned when the campaign is
+        #   approved, not at request time. Not available when the profile inherits the
+        #   organization's campaign.
+        #
+        #   @return [Array<Sentdm::Models::Channels::SMSNumberRequest>, nil]
+        optional :numbers,
+                 -> {
+                   Sentdm::Internal::Type::ArrayOf[Sentdm::Channels::SMSNumberRequest]
+                 },
+                 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 sender_value
+        #   The sender's identity where the caller chooses it. Required when number_type is
+        #   ALPHANUMERIC; optional for carrier-assigned types, which are procured
+        #   afterwards.
+        #
+        #   @return [String, nil]
+        optional :sender_value, String, nil?: true
+
+        # @!attribute idempotency_key
+        #
+        #   @return [String, nil]
+        optional :idempotency_key, String
+
+        # @!attribute x_profile_id
+        #
+        #   @return [String, nil]
+        optional :x_profile_id, String
+
+        # @!method initialize(number_type:, area_codes: nil, compliance: nil, country: nil, numbers: nil, sandbox: nil, sender_value: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Sentdm::Models::Channels::SMSCreateParams} for more details.
+        #
+        #   @param number_type [Symbol, Sentdm::Models::Channels::SMSCreateParams::NumberType] Sender type. Decides the provisioning flow and what compliance is asked for.
+        #
+        #   @param area_codes [Array<String>, nil] The area codes to put this sender in, in your own order of preference, e.g. ["41
+        #
+        #   @param compliance [Sentdm::Models::Channels::MarketCompliance] The compliance values a market registers with. `brand` and `campaign` apply to U
+        #
+        #   @param country [String] ISO 3166-1 alpha-2 country the sender operates in.
+        #
+        #   @param numbers [Array<Sentdm::Models::Channels::SMSNumberRequest>, nil] The numbers to assign, one entry per area code, e.g.
+        #
+        #   @param sandbox [Boolean] Sandbox flag - when true, the operation is simulated without side effects
+        #
+        #   @param sender_value [String, nil] The sender's identity where the caller chooses it. Required when number_type is
+        #
+        #   @param idempotency_key [String]
+        #
+        #   @param x_profile_id [String]
+        #
+        #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
+
+        # Sender type. Decides the provisioning flow and what compliance is asked for.
+        #
+        # [Required] so the published document says so. The validator has always demanded
+        # it, but requiredness reached the schema by matching a rule to a property name —
+        # which works for country, whose wire name is its camel-cased C# name, and
+        # silently does not for number_type. A client generating a request from our
+        # OpenAPI therefore sent what the document called sufficient and was answered 400.
+        module NumberType
+          extend Sentdm::Internal::Type::Enum
+
+          # A geographic number for the country. The ordinary choice: recognisable to recipients, and available almost everywhere.
+          LOCAL = :LOCAL
+
+          # A toll-free number. High throughput and no per-country registration, but US toll-free traffic goes through its own verification.
+          TOLL_FREE = :TOLL_FREE
+
+          # A short code — five or six digits, leased rather than provisioned. Highest throughput, longest lead time, and the most expensive.
+          SHORT_CODE = :SHORT_CODE
+
+          # A sender name rather than a number, up to 11 characters. Recipients cannot reply. Not available in every country, and several require it to be pre-registered with documents.
+          ALPHANUMERIC = :ALPHANUMERIC
+
+          # A US 10-digit long code registered with The Campaign Registry. The only sender type that registers with a compliance regime, so it is the only one whose market declares `compliance.brand` and `compliance.campaign`.
+          TEN_DLC = :TEN_DLC
+
+          # A mobile number. Where a country distinguishes it from a landline, some carriers treat mobile traffic differently.
+          MOBILE = :MOBILE
+
+          # The industry's spelling of `TEN_DLC`, accepted so an integrator can send the term it knows. Resolves to the same market.
+          NUMBER_TYPE_10_DLC = :"10DLC"
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Channels
+      # @see Sentdm::Resources::Channels::SMS#list
+      class SMSListParams < 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
+end

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

@@ -0,0 +1,158 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Channels
+      class SMSMarket < Sentdm::Internal::Type::BaseModel
+        # @!attribute compliance
+        #   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.
+        #
+        #   @return [Sentdm::Models::Channels::SuppliedCompliance, nil]
+        optional :compliance, -> { Sentdm::Channels::SuppliedCompliance }, nil?: true
+
+        # @!attribute country
+        #
+        #   @return [String, nil]
+        optional :country, String, nil?: true
+
+        # @!attribute number_type
+        #
+        #   @return [String, nil]
+        optional :number_type, String, nil?: true
+
+        # @!attribute numbers
+        #   Every number this market holds or is still owed, each with its area code and its
+        #   own status (ACTIVE once it can send, PROVISIONING while it is still to be
+        #   assigned, INACTIVE once it could send and no longer can). One entry for a market
+        #   holding one number. US 10DLC numbers are assigned when the campaign is approved,
+        #   so they read as owed until then. Read-only.
+        #
+        #   @return [Array<Sentdm::Models::Channels::SMSNumber>, nil]
+        optional :numbers, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::Channels::SMSNumber] }
+
+        # @!attribute reason
+        #   A sentence for reason_code: this market's own explanation, naming what is
+        #   outstanding where that is you. Omitted while ACTIVE.
+        #
+        #   @return [String, nil]
+        optional :reason, String, nil?: true
+
+        # @!attribute reason_code
+        #   Why the market 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 sender_value
+        #   The sender itself. Null until a carrier-assigned number is procured. For a
+        #   market holding several numbers, the first active one (the first assigned while
+        #   none is active) — every number is in numbers.
+        #
+        #   @return [String, nil]
+        optional :sender_value, String, nil?: true
+
+        # @!attribute status
+        #   Where this market's sender stands, in terms of who is holding it up —
+        #   PROVISIONING, ACTION_NEEDED, PENDING_REVIEW or ACTIVE. Read-only.
+        #
+        #   Resolved rather than reported raw: a live sender reads ACTIVE whatever it still
+        #   owes, a market with outstanding requirements or an open resubmission request
+        #   reads ACTION_NEEDED, and a market that registers with a regime reads
+        #   PENDING_REVIEW once its brand exists — filing to The Campaign Registry is ours
+        #   to do and need not have happened yet, so a dedicated brand created through this
+        #   API reads PENDING_REVIEW from the moment it is stored.
+        #
+        #   Describes whether the market can send, not each number: a market holding several
+        #   numbers reads ACTIVE as soon as one of them is, whatever the others are doing.
+        #   Each number's own status is in numbers.
+        #
+        #   @return [Symbol, Sentdm::Models::Channels::SMSMarket::Status, nil]
+        optional :status, enum: -> { Sentdm::Channels::SMSMarket::Status }, nil?: true
+
+        # @!method initialize(compliance: nil, country: nil, number_type: nil, numbers: nil, reason: nil, reason_code: nil, sender_value: nil, status: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Sentdm::Models::Channels::SMSMarket} for more details.
+        #
+        #   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.
+        #
+        #   @param compliance [Sentdm::Models::Channels::SuppliedCompliance, nil] What a market has been given: the identity it registers under, its programme, an
+        #
+        #   @param country [String, nil]
+        #
+        #   @param number_type [String, nil]
+        #
+        #   @param numbers [Array<Sentdm::Models::Channels::SMSNumber>] Every number this market holds or is still owed, each with its area code and its
+        #
+        #   @param reason [String, nil] A sentence for reason_code: this market's own explanation, naming what is outsta
+        #
+        #   @param reason_code [String, nil] Why the market is not ACTIVE, as a stable code: an ErrorCodes CHANNEL_xxx value
+        #
+        #   @param sender_value [String, nil] The sender itself. Null until a carrier-assigned number is procured. For a marke
+        #
+        #   @param status [Symbol, Sentdm::Models::Channels::SMSMarket::Status, nil] Where this market's sender stands, in terms of who is holding it up — PROVISIONI
+
+        # Where this market's sender stands, in terms of who is holding it up —
+        # PROVISIONING, ACTION_NEEDED, PENDING_REVIEW or ACTIVE. Read-only.
+        #
+        # Resolved rather than reported raw: a live sender reads ACTIVE whatever it still
+        # owes, a market with outstanding requirements or an open resubmission request
+        # reads ACTION_NEEDED, and a market that registers with a regime reads
+        # PENDING_REVIEW once its brand exists — filing to The Campaign Registry is ours
+        # to do and need not have happened yet, so a dedicated brand created through this
+        # API reads PENDING_REVIEW from the moment it is stored.
+        #
+        # Describes whether the market can send, not each number: a market holding several
+        # numbers reads ACTIVE as soon as one of them is, whatever the others are doing.
+        # Each number's own status is in numbers.
+        #
+        # @see Sentdm::Models::Channels::SMSMarket#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
+  end
+end