sentdm 0.44.0 → 0.46.0

data/sig/sentdm/models/channels/rcs_agent.rbs

@@ -0,0 +1,181 @@
+module Sentdm
+  module Models
+    module Channels
+      type rcs_agent =
+        {
+          id: String?,
+          agent_use_case: String?,
+          brand_color: String?,
+          brand_email: String?,
+          brand_name: String?,
+          brand_phone_number: String?,
+          brief_company_description: String?,
+          company_ein: String?,
+          contact_name_and_title: String?,
+          created_at: Time?,
+          customer_support_email: String?,
+          customer_support_phone_number: String?,
+          description: String?,
+          display_name: String?,
+          entity_type: String?,
+          help_message: String?,
+          official_address: Sentdm::Channels::RcsAddress?,
+          opt_in_process_description: String?,
+          phone_number: String?,
+          privacy_policy_url: String?,
+          reason: String?,
+          reason_code: String?,
+          sample_messages: ::Array[String]?,
+          start_message: String?,
+          status: Sentdm::Models::Channels::RcsAgent::status?,
+          stop_message: String?,
+          terms_and_conditions_url: String?,
+          website_url: String?
+        }
+
+      class RcsAgent < Sentdm::Internal::Type::BaseModel
+        attr_accessor id: String?
+
+        attr_accessor agent_use_case: String?
+
+        attr_accessor brand_color: String?
+
+        attr_accessor brand_email: String?
+
+        attr_accessor brand_name: String?
+
+        attr_accessor brand_phone_number: String?
+
+        attr_accessor brief_company_description: String?
+
+        attr_accessor company_ein: String?
+
+        attr_accessor contact_name_and_title: String?
+
+        attr_accessor created_at: Time?
+
+        attr_accessor customer_support_email: String?
+
+        attr_accessor customer_support_phone_number: String?
+
+        attr_accessor description: String?
+
+        attr_accessor display_name: String?
+
+        attr_accessor entity_type: String?
+
+        attr_accessor help_message: String?
+
+        attr_accessor official_address: Sentdm::Channels::RcsAddress?
+
+        attr_accessor opt_in_process_description: String?
+
+        attr_accessor phone_number: String?
+
+        attr_accessor privacy_policy_url: String?
+
+        attr_accessor reason: String?
+
+        attr_accessor reason_code: String?
+
+        attr_accessor sample_messages: ::Array[String]?
+
+        attr_accessor start_message: String?
+
+        attr_accessor status: Sentdm::Models::Channels::RcsAgent::status?
+
+        attr_accessor stop_message: String?
+
+        attr_accessor terms_and_conditions_url: String?
+
+        attr_accessor website_url: String?
+
+        def initialize: (
+          ?id: String?,
+          ?agent_use_case: String?,
+          ?brand_color: String?,
+          ?brand_email: String?,
+          ?brand_name: String?,
+          ?brand_phone_number: String?,
+          ?brief_company_description: String?,
+          ?company_ein: String?,
+          ?contact_name_and_title: String?,
+          ?created_at: Time?,
+          ?customer_support_email: String?,
+          ?customer_support_phone_number: String?,
+          ?description: String?,
+          ?display_name: String?,
+          ?entity_type: String?,
+          ?help_message: String?,
+          ?official_address: Sentdm::Channels::RcsAddress?,
+          ?opt_in_process_description: String?,
+          ?phone_number: String?,
+          ?privacy_policy_url: String?,
+          ?reason: String?,
+          ?reason_code: String?,
+          ?sample_messages: ::Array[String]?,
+          ?start_message: String?,
+          ?status: Sentdm::Models::Channels::RcsAgent::status?,
+          ?stop_message: String?,
+          ?terms_and_conditions_url: String?,
+          ?website_url: String?
+        ) -> void
+
+        def to_hash: -> {
+          id: String?,
+          agent_use_case: String?,
+          brand_color: String?,
+          brand_email: String?,
+          brand_name: String?,
+          brand_phone_number: String?,
+          brief_company_description: String?,
+          company_ein: String?,
+          contact_name_and_title: String?,
+          created_at: Time?,
+          customer_support_email: String?,
+          customer_support_phone_number: String?,
+          description: String?,
+          display_name: String?,
+          entity_type: String?,
+          help_message: String?,
+          official_address: Sentdm::Channels::RcsAddress?,
+          opt_in_process_description: String?,
+          phone_number: String?,
+          privacy_policy_url: String?,
+          reason: String?,
+          reason_code: String?,
+          sample_messages: ::Array[String]?,
+          start_message: String?,
+          status: Sentdm::Models::Channels::RcsAgent::status?,
+          stop_message: String?,
+          terms_and_conditions_url: String?,
+          website_url: String?
+        }
+
+        type status =
+          :PROVISIONING | :ACTION_NEEDED | :PENDING_REVIEW | :ACTIVE | :INACTIVE
+
+        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
+
+          def self?.values: -> ::Array[Sentdm::Models::Channels::RcsAgent::status]
+        end
+      end
+    end
+  end
+end

data/sig/sentdm/models/channels/sms_create_params.rbs

@@ -0,0 +1,116 @@
+module Sentdm
+  module Models
+    module Channels
+      type sms_create_params =
+        {
+          number_type: Sentdm::Models::Channels::SMSCreateParams::number_type,
+          area_codes: ::Array[String]?,
+          compliance: Sentdm::Channels::MarketCompliance,
+          country: String,
+          numbers: ::Array[Sentdm::Channels::SMSNumberRequest]?,
+          sandbox: bool,
+          sender_value: String?,
+          idempotency_key: String,
+          x_profile_id: String
+        }
+        & Sentdm::Internal::Type::request_parameters
+
+      class SMSCreateParams < Sentdm::Internal::Type::BaseModel
+        extend Sentdm::Internal::Type::RequestParameters::Converter
+        include Sentdm::Internal::Type::RequestParameters
+
+        attr_accessor number_type: Sentdm::Models::Channels::SMSCreateParams::number_type
+
+        attr_accessor area_codes: ::Array[String]?
+
+        attr_reader compliance: Sentdm::Channels::MarketCompliance?
+
+        def compliance=: (
+          Sentdm::Channels::MarketCompliance
+        ) -> Sentdm::Channels::MarketCompliance
+
+        attr_reader country: String?
+
+        def country=: (String) -> String
+
+        attr_accessor numbers: ::Array[Sentdm::Channels::SMSNumberRequest]?
+
+        attr_reader sandbox: bool?
+
+        def sandbox=: (bool) -> bool
+
+        attr_accessor sender_value: String?
+
+        attr_reader idempotency_key: String?
+
+        def idempotency_key=: (String) -> String
+
+        attr_reader x_profile_id: String?
+
+        def x_profile_id=: (String) -> String
+
+        def initialize: (
+          number_type: Sentdm::Models::Channels::SMSCreateParams::number_type,
+          ?area_codes: ::Array[String]?,
+          ?compliance: Sentdm::Channels::MarketCompliance,
+          ?country: String,
+          ?numbers: ::Array[Sentdm::Channels::SMSNumberRequest]?,
+          ?sandbox: bool,
+          ?sender_value: String?,
+          ?idempotency_key: String,
+          ?x_profile_id: String,
+          ?request_options: Sentdm::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          number_type: Sentdm::Models::Channels::SMSCreateParams::number_type,
+          area_codes: ::Array[String]?,
+          compliance: Sentdm::Channels::MarketCompliance,
+          country: String,
+          numbers: ::Array[Sentdm::Channels::SMSNumberRequest]?,
+          sandbox: bool,
+          sender_value: String?,
+          idempotency_key: String,
+          x_profile_id: String,
+          request_options: Sentdm::RequestOptions
+        }
+
+        type number_type =
+          :LOCAL
+          | :TOLL_FREE
+          | :SHORT_CODE
+          | :ALPHANUMERIC
+          | :TEN_DLC
+          | :MOBILE
+          | :"10DLC"
+
+        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"
+
+          def self?.values: -> ::Array[Sentdm::Models::Channels::SMSCreateParams::number_type]
+        end
+      end
+    end
+  end
+end

data/sig/sentdm/models/channels/sms_list_params.rbs

@@ -0,0 +1,27 @@
+module Sentdm
+  module Models
+    module Channels
+      type sms_list_params =
+        { x_profile_id: String } & Sentdm::Internal::Type::request_parameters
+
+      class SMSListParams < Sentdm::Internal::Type::BaseModel
+        extend Sentdm::Internal::Type::RequestParameters::Converter
+        include Sentdm::Internal::Type::RequestParameters
+
+        attr_reader x_profile_id: String?
+
+        def x_profile_id=: (String) -> String
+
+        def initialize: (
+          ?x_profile_id: String,
+          ?request_options: Sentdm::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          x_profile_id: String,
+          request_options: Sentdm::RequestOptions
+        }
+      end
+    end
+  end
+end

data/sig/sentdm/models/channels/sms_market.rbs

@@ -0,0 +1,85 @@
+module Sentdm
+  module Models
+    module Channels
+      type sms_market =
+        {
+          compliance: Sentdm::Channels::SuppliedCompliance?,
+          country: String?,
+          number_type: String?,
+          numbers: ::Array[Sentdm::Channels::SMSNumber],
+          reason: String?,
+          reason_code: String?,
+          sender_value: String?,
+          status: Sentdm::Models::Channels::SMSMarket::status?
+        }
+
+      class SMSMarket < Sentdm::Internal::Type::BaseModel
+        attr_accessor compliance: Sentdm::Channels::SuppliedCompliance?
+
+        attr_accessor country: String?
+
+        attr_accessor number_type: String?
+
+        attr_reader numbers: ::Array[Sentdm::Channels::SMSNumber]?
+
+        def numbers=: (
+          ::Array[Sentdm::Channels::SMSNumber]
+        ) -> ::Array[Sentdm::Channels::SMSNumber]
+
+        attr_accessor reason: String?
+
+        attr_accessor reason_code: String?
+
+        attr_accessor sender_value: String?
+
+        attr_accessor status: Sentdm::Models::Channels::SMSMarket::status?
+
+        def initialize: (
+          ?compliance: Sentdm::Channels::SuppliedCompliance?,
+          ?country: String?,
+          ?number_type: String?,
+          ?numbers: ::Array[Sentdm::Channels::SMSNumber],
+          ?reason: String?,
+          ?reason_code: String?,
+          ?sender_value: String?,
+          ?status: Sentdm::Models::Channels::SMSMarket::status?
+        ) -> void
+
+        def to_hash: -> {
+          compliance: Sentdm::Channels::SuppliedCompliance?,
+          country: String?,
+          number_type: String?,
+          numbers: ::Array[Sentdm::Channels::SMSNumber],
+          reason: String?,
+          reason_code: String?,
+          sender_value: String?,
+          status: Sentdm::Models::Channels::SMSMarket::status?
+        }
+
+        type status =
+          :PROVISIONING | :ACTION_NEEDED | :PENDING_REVIEW | :ACTIVE | :INACTIVE
+
+        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
+
+          def self?.values: -> ::Array[Sentdm::Models::Channels::SMSMarket::status]
+        end
+      end
+    end
+  end
+end

data/sig/sentdm/models/channels/sms_number.rbs

@@ -0,0 +1,28 @@
+module Sentdm
+  module Models
+    module Channels
+      type sms_number =
+        { area_code: String?, sender_value: String?, status: String? }
+
+      class SMSNumber < Sentdm::Internal::Type::BaseModel
+        attr_accessor area_code: String?
+
+        attr_accessor sender_value: String?
+
+        attr_accessor status: String?
+
+        def initialize: (
+          ?area_code: String?,
+          ?sender_value: String?,
+          ?status: String?
+        ) -> void
+
+        def to_hash: -> {
+          area_code: String?,
+          sender_value: String?,
+          status: String?
+        }
+      end
+    end
+  end
+end

data/sig/sentdm/models/channels/sms_number_request.rbs

@@ -0,0 +1,17 @@
+module Sentdm
+  module Models
+    module Channels
+      type sms_number_request = { area_code: String?, quantity: Integer? }
+
+      class SMSNumberRequest < Sentdm::Internal::Type::BaseModel
+        attr_accessor area_code: String?
+
+        attr_accessor quantity: Integer?
+
+        def initialize: (?area_code: String?, ?quantity: Integer?) -> void
+
+        def to_hash: -> { area_code: String?, quantity: Integer? }
+      end
+    end
+  end
+end

data/sig/sentdm/models/channels/sms_retrieve_params.rbs

@@ -0,0 +1,36 @@
+module Sentdm
+  module Models
+    module Channels
+      type sms_retrieve_params =
+        { country: String, type: String, x_profile_id: String }
+        & Sentdm::Internal::Type::request_parameters
+
+      class SMSRetrieveParams < Sentdm::Internal::Type::BaseModel
+        extend Sentdm::Internal::Type::RequestParameters::Converter
+        include Sentdm::Internal::Type::RequestParameters
+
+        attr_accessor country: String
+
+        attr_accessor type: String
+
+        attr_reader x_profile_id: String?
+
+        def x_profile_id=: (String) -> String
+
+        def initialize: (
+          country: String,
+          type: String,
+          ?x_profile_id: String,
+          ?request_options: Sentdm::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          country: String,
+          type: String,
+          x_profile_id: String,
+          request_options: Sentdm::RequestOptions
+        }
+      end
+    end
+  end
+end

data/sig/sentdm/models/channels/sms_update_params.rbs

@@ -0,0 +1,63 @@
+module Sentdm
+  module Models
+    module Channels
+      type sms_update_params =
+        {
+          country: String,
+          type: String,
+          compliance: Sentdm::Channels::MarketCompliance,
+          sandbox: bool,
+          idempotency_key: String,
+          x_profile_id: String
+        }
+        & Sentdm::Internal::Type::request_parameters
+
+      class SMSUpdateParams < Sentdm::Internal::Type::BaseModel
+        extend Sentdm::Internal::Type::RequestParameters::Converter
+        include Sentdm::Internal::Type::RequestParameters
+
+        attr_accessor country: String
+
+        attr_accessor type: String
+
+        attr_reader compliance: Sentdm::Channels::MarketCompliance?
+
+        def compliance=: (
+          Sentdm::Channels::MarketCompliance
+        ) -> Sentdm::Channels::MarketCompliance
+
+        attr_reader sandbox: bool?
+
+        def sandbox=: (bool) -> bool
+
+        attr_reader idempotency_key: String?
+
+        def idempotency_key=: (String) -> String
+
+        attr_reader x_profile_id: String?
+
+        def x_profile_id=: (String) -> String
+
+        def initialize: (
+          country: String,
+          type: String,
+          ?compliance: Sentdm::Channels::MarketCompliance,
+          ?sandbox: bool,
+          ?idempotency_key: String,
+          ?x_profile_id: String,
+          ?request_options: Sentdm::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          country: String,
+          type: String,
+          compliance: Sentdm::Channels::MarketCompliance,
+          sandbox: bool,
+          idempotency_key: String,
+          x_profile_id: String,
+          request_options: Sentdm::RequestOptions
+        }
+      end
+    end
+  end
+end

data/sig/sentdm/models/channels/supplied_compliance.rbs

@@ -0,0 +1,32 @@
+module Sentdm
+  module Models
+    module Channels
+      type supplied_compliance =
+        {
+          brand: ::Hash[Symbol, top]?,
+          campaign: ::Hash[Symbol, top]?,
+          documents: ::Array[Sentdm::Channels::SuppliedDocument]?
+        }
+
+      class SuppliedCompliance < Sentdm::Internal::Type::BaseModel
+        attr_accessor brand: ::Hash[Symbol, top]?
+
+        attr_accessor campaign: ::Hash[Symbol, top]?
+
+        attr_accessor documents: ::Array[Sentdm::Channels::SuppliedDocument]?
+
+        def initialize: (
+          ?brand: ::Hash[Symbol, top]?,
+          ?campaign: ::Hash[Symbol, top]?,
+          ?documents: ::Array[Sentdm::Channels::SuppliedDocument]?
+        ) -> void
+
+        def to_hash: -> {
+          brand: ::Hash[Symbol, top]?,
+          campaign: ::Hash[Symbol, top]?,
+          documents: ::Array[Sentdm::Channels::SuppliedDocument]?
+        }
+      end
+    end
+  end
+end

data/sig/sentdm/models/channels/supplied_document.rbs

@@ -0,0 +1,30 @@
+module Sentdm
+  module Models
+    module Channels
+      type supplied_document =
+        { document_id: String?, file_name: String?, key: String }
+
+      class SuppliedDocument < Sentdm::Internal::Type::BaseModel
+        attr_accessor document_id: String?
+
+        attr_accessor file_name: String?
+
+        attr_reader key: String?
+
+        def key=: (String) -> String
+
+        def initialize: (
+          ?document_id: String?,
+          ?file_name: String?,
+          ?key: String
+        ) -> void
+
+        def to_hash: -> {
+          document_id: String?,
+          file_name: String?,
+          key: String
+        }
+      end
+    end
+  end
+end