sentdm 0.45.0 → 0.46.0

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

@@ -0,0 +1,338 @@
+module Sentdm
+  module Models
+    module Channels
+      type market_compliance =
+        {
+          brand: Sentdm::Channels::MarketCompliance::Brand,
+          campaign: Sentdm::Channels::MarketCompliance::Campaign
+        }
+
+      class MarketCompliance < Sentdm::Internal::Type::BaseModel
+        attr_reader brand: Sentdm::Channels::MarketCompliance::Brand?
+
+        def brand=: (
+          Sentdm::Channels::MarketCompliance::Brand
+        ) -> Sentdm::Channels::MarketCompliance::Brand
+
+        attr_reader campaign: Sentdm::Channels::MarketCompliance::Campaign?
+
+        def campaign=: (
+          Sentdm::Channels::MarketCompliance::Campaign
+        ) -> Sentdm::Channels::MarketCompliance::Campaign
+
+        def initialize: (
+          ?brand: Sentdm::Channels::MarketCompliance::Brand,
+          ?campaign: Sentdm::Channels::MarketCompliance::Campaign
+        ) -> void
+
+        def to_hash: -> {
+          brand: Sentdm::Channels::MarketCompliance::Brand,
+          campaign: Sentdm::Channels::MarketCompliance::Campaign
+        }
+
+        type brand =
+          {
+            business_name: String,
+            city: String,
+            contact_email: String,
+            contact_name: String,
+            contact_phone: String,
+            country: String,
+            ein_issuing_country: String,
+            entity_type: Sentdm::Models::Channels::MarketCompliance::Brand::entity_type,
+            inherit: bool,
+            legal_name: String,
+            postal_code: String,
+            state: String,
+            street: String,
+            tax_id: String,
+            tax_id_type: String,
+            website: String
+          }
+
+        class Brand < Sentdm::Internal::Type::BaseModel
+          attr_reader business_name: String?
+
+          def business_name=: (String) -> String
+
+          attr_reader city: String?
+
+          def city=: (String) -> String
+
+          attr_reader contact_email: String?
+
+          def contact_email=: (String) -> String
+
+          attr_reader contact_name: String?
+
+          def contact_name=: (String) -> String
+
+          attr_reader contact_phone: String?
+
+          def contact_phone=: (String) -> String
+
+          attr_reader country: String?
+
+          def country=: (String) -> String
+
+          attr_reader ein_issuing_country: String?
+
+          def ein_issuing_country=: (String) -> String
+
+          attr_reader entity_type: Sentdm::Models::Channels::MarketCompliance::Brand::entity_type?
+
+          def entity_type=: (
+            Sentdm::Models::Channels::MarketCompliance::Brand::entity_type
+          ) -> Sentdm::Models::Channels::MarketCompliance::Brand::entity_type
+
+          attr_reader inherit: bool?
+
+          def inherit=: (bool) -> bool
+
+          attr_reader legal_name: String?
+
+          def legal_name=: (String) -> String
+
+          attr_reader postal_code: String?
+
+          def postal_code=: (String) -> String
+
+          attr_reader state: String?
+
+          def state=: (String) -> String
+
+          attr_reader street: String?
+
+          def street=: (String) -> String
+
+          attr_reader tax_id: String?
+
+          def tax_id=: (String) -> String
+
+          attr_reader tax_id_type: String?
+
+          def tax_id_type=: (String) -> String
+
+          attr_reader website: String?
+
+          def website=: (String) -> String
+
+          def initialize: (
+            ?business_name: String,
+            ?city: String,
+            ?contact_email: String,
+            ?contact_name: String,
+            ?contact_phone: String,
+            ?country: String,
+            ?ein_issuing_country: String,
+            ?entity_type: Sentdm::Models::Channels::MarketCompliance::Brand::entity_type,
+            ?inherit: bool,
+            ?legal_name: String,
+            ?postal_code: String,
+            ?state: String,
+            ?street: String,
+            ?tax_id: String,
+            ?tax_id_type: String,
+            ?website: String
+          ) -> void
+
+          def to_hash: -> {
+            business_name: String,
+            city: String,
+            contact_email: String,
+            contact_name: String,
+            contact_phone: String,
+            country: String,
+            ein_issuing_country: String,
+            entity_type: Sentdm::Models::Channels::MarketCompliance::Brand::entity_type,
+            inherit: bool,
+            legal_name: String,
+            postal_code: String,
+            state: String,
+            street: String,
+            tax_id: String,
+            tax_id_type: String,
+            website: String
+          }
+
+          type entity_type =
+            :PRIVATE_PROFIT
+            | :PUBLIC_PROFIT
+            | :NON_PROFIT
+            | :SOLE_PROPRIETOR
+            | :GOVERNMENT
+
+          module EntityType
+            extend Sentdm::Internal::Type::Enum
+
+            PRIVATE_PROFIT: :PRIVATE_PROFIT
+            PUBLIC_PROFIT: :PUBLIC_PROFIT
+            NON_PROFIT: :NON_PROFIT
+            SOLE_PROPRIETOR: :SOLE_PROPRIETOR
+            GOVERNMENT: :GOVERNMENT
+
+            def self?.values: -> ::Array[Sentdm::Models::Channels::MarketCompliance::Brand::entity_type]
+          end
+        end
+
+        type campaign =
+          {
+            description: String,
+            help_keywords: String,
+            help_message: String,
+            inherit: bool,
+            message_flow: String,
+            opt_in_keywords: String,
+            opt_in_message: String,
+            opt_out_keywords: String,
+            opt_out_message: String,
+            privacy_policy_link: String,
+            terms_and_conditions_link: String,
+            use_cases: ::Array[Sentdm::Channels::MarketCompliance::Campaign::UseCase],
+            volume: String
+          }
+
+        class Campaign < Sentdm::Internal::Type::BaseModel
+          attr_reader description: String?
+
+          def description=: (String) -> String
+
+          attr_reader help_keywords: String?
+
+          def help_keywords=: (String) -> String
+
+          attr_reader help_message: String?
+
+          def help_message=: (String) -> String
+
+          attr_reader inherit: bool?
+
+          def inherit=: (bool) -> bool
+
+          attr_reader message_flow: String?
+
+          def message_flow=: (String) -> String
+
+          attr_reader opt_in_keywords: String?
+
+          def opt_in_keywords=: (String) -> String
+
+          attr_reader opt_in_message: String?
+
+          def opt_in_message=: (String) -> String
+
+          attr_reader opt_out_keywords: String?
+
+          def opt_out_keywords=: (String) -> String
+
+          attr_reader opt_out_message: String?
+
+          def opt_out_message=: (String) -> String
+
+          attr_reader privacy_policy_link: String?
+
+          def privacy_policy_link=: (String) -> String
+
+          attr_reader terms_and_conditions_link: String?
+
+          def terms_and_conditions_link=: (String) -> String
+
+          attr_reader use_cases: ::Array[Sentdm::Channels::MarketCompliance::Campaign::UseCase]?
+
+          def use_cases=: (
+            ::Array[Sentdm::Channels::MarketCompliance::Campaign::UseCase]
+          ) -> ::Array[Sentdm::Channels::MarketCompliance::Campaign::UseCase]
+
+          attr_reader volume: String?
+
+          def volume=: (String) -> String
+
+          def initialize: (
+            ?description: String,
+            ?help_keywords: String,
+            ?help_message: String,
+            ?inherit: bool,
+            ?message_flow: String,
+            ?opt_in_keywords: String,
+            ?opt_in_message: String,
+            ?opt_out_keywords: String,
+            ?opt_out_message: String,
+            ?privacy_policy_link: String,
+            ?terms_and_conditions_link: String,
+            ?use_cases: ::Array[Sentdm::Channels::MarketCompliance::Campaign::UseCase],
+            ?volume: String
+          ) -> void
+
+          def to_hash: -> {
+            description: String,
+            help_keywords: String,
+            help_message: String,
+            inherit: bool,
+            message_flow: String,
+            opt_in_keywords: String,
+            opt_in_message: String,
+            opt_out_keywords: String,
+            opt_out_message: String,
+            privacy_policy_link: String,
+            terms_and_conditions_link: String,
+            use_cases: ::Array[Sentdm::Channels::MarketCompliance::Campaign::UseCase],
+            volume: String
+          }
+
+          type use_case =
+            {
+              sample_messages: ::Array[top],
+              use_case: Sentdm::Models::Channels::MarketCompliance::Campaign::UseCase::use_case
+            }
+
+          class UseCase < Sentdm::Internal::Type::BaseModel
+            attr_accessor sample_messages: ::Array[top]
+
+            attr_accessor use_case: Sentdm::Models::Channels::MarketCompliance::Campaign::UseCase::use_case
+
+            def initialize: (
+              sample_messages: ::Array[top],
+              use_case: Sentdm::Models::Channels::MarketCompliance::Campaign::UseCase::use_case
+            ) -> void
+
+            def to_hash: -> {
+              sample_messages: ::Array[top],
+              use_case: Sentdm::Models::Channels::MarketCompliance::Campaign::UseCase::use_case
+            }
+
+            type use_case =
+              :MARKETING
+              | :ACCOUNT_NOTIFICATION
+              | :CUSTOMER_CARE
+              | :FRAUD_ALERT
+              | :"2FA"
+              | :DELIVERY_NOTIFICATION
+              | :SECURITY_ALERT
+              | :M2M
+              | :HIGHER_EDUCATION
+              | :POLLING_VOTING
+              | :PUBLIC_SERVICE_ANNOUNCEMENT
+
+            module UseCase
+              extend Sentdm::Internal::Type::Enum
+
+              MARKETING: :MARKETING
+              ACCOUNT_NOTIFICATION: :ACCOUNT_NOTIFICATION
+              CUSTOMER_CARE: :CUSTOMER_CARE
+              FRAUD_ALERT: :FRAUD_ALERT
+              USE_CASE_2_FA: :"2FA"
+              DELIVERY_NOTIFICATION: :DELIVERY_NOTIFICATION
+              SECURITY_ALERT: :SECURITY_ALERT
+              M2_M: :M2M
+              HIGHER_EDUCATION: :HIGHER_EDUCATION
+              POLLING_VOTING: :POLLING_VOTING
+              PUBLIC_SERVICE_ANNOUNCEMENT: :PUBLIC_SERVICE_ANNOUNCEMENT
+
+              def self?.values: -> ::Array[Sentdm::Models::Channels::MarketCompliance::Campaign::UseCase::use_case]
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,242 @@
+module Sentdm
+  module Models
+    module Channels
+      type rc_create_params =
+        {
+          agent_use_case: Sentdm::Models::Channels::RcCreateParams::agent_use_case,
+          banner_url: 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,
+          customer_support_email: String,
+          customer_support_phone_number: String,
+          description: String,
+          display_name: String,
+          entity_type: String,
+          help_message: String,
+          logo_url: String,
+          official_address: Sentdm::Channels::RcsAddress,
+          opt_in_process_description: String,
+          opt_in_screenshot_url: String?,
+          privacy_policy_url: String,
+          sample_messages: ::Array[String],
+          sandbox: bool,
+          start_message: String,
+          stop_message: String,
+          terms_and_conditions_url: String,
+          website_url: String,
+          idempotency_key: String,
+          x_profile_id: String
+        }
+        & Sentdm::Internal::Type::request_parameters
+
+      class RcCreateParams < Sentdm::Internal::Type::BaseModel
+        extend Sentdm::Internal::Type::RequestParameters::Converter
+        include Sentdm::Internal::Type::RequestParameters
+
+        attr_reader agent_use_case: Sentdm::Models::Channels::RcCreateParams::agent_use_case?
+
+        def agent_use_case=: (
+          Sentdm::Models::Channels::RcCreateParams::agent_use_case
+        ) -> Sentdm::Models::Channels::RcCreateParams::agent_use_case
+
+        attr_reader banner_url: String?
+
+        def banner_url=: (String) -> String
+
+        attr_reader brand_color: String?
+
+        def brand_color=: (String) -> String
+
+        attr_reader brand_email: String?
+
+        def brand_email=: (String) -> String
+
+        attr_reader brand_name: String?
+
+        def brand_name=: (String) -> String
+
+        attr_reader brand_phone_number: String?
+
+        def brand_phone_number=: (String) -> String
+
+        attr_reader brief_company_description: String?
+
+        def brief_company_description=: (String) -> String
+
+        attr_reader company_ein: String?
+
+        def company_ein=: (String) -> String
+
+        attr_reader contact_name_and_title: String?
+
+        def contact_name_and_title=: (String) -> String
+
+        attr_reader customer_support_email: String?
+
+        def customer_support_email=: (String) -> String
+
+        attr_reader customer_support_phone_number: String?
+
+        def customer_support_phone_number=: (String) -> String
+
+        attr_reader description: String?
+
+        def description=: (String) -> String
+
+        attr_reader display_name: String?
+
+        def display_name=: (String) -> String
+
+        attr_reader entity_type: String?
+
+        def entity_type=: (String) -> String
+
+        attr_reader help_message: String?
+
+        def help_message=: (String) -> String
+
+        attr_reader logo_url: String?
+
+        def logo_url=: (String) -> String
+
+        attr_reader official_address: Sentdm::Channels::RcsAddress?
+
+        def official_address=: (
+          Sentdm::Channels::RcsAddress
+        ) -> Sentdm::Channels::RcsAddress
+
+        attr_reader opt_in_process_description: String?
+
+        def opt_in_process_description=: (String) -> String
+
+        attr_accessor opt_in_screenshot_url: String?
+
+        attr_reader privacy_policy_url: String?
+
+        def privacy_policy_url=: (String) -> String
+
+        attr_reader sample_messages: ::Array[String]?
+
+        def sample_messages=: (::Array[String]) -> ::Array[String]
+
+        attr_reader sandbox: bool?
+
+        def sandbox=: (bool) -> bool
+
+        attr_reader start_message: String?
+
+        def start_message=: (String) -> String
+
+        attr_reader stop_message: String?
+
+        def stop_message=: (String) -> String
+
+        attr_reader terms_and_conditions_url: String?
+
+        def terms_and_conditions_url=: (String) -> String
+
+        attr_reader website_url: String?
+
+        def website_url=: (String) -> 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: (
+          ?agent_use_case: Sentdm::Models::Channels::RcCreateParams::agent_use_case,
+          ?banner_url: 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,
+          ?customer_support_email: String,
+          ?customer_support_phone_number: String,
+          ?description: String,
+          ?display_name: String,
+          ?entity_type: String,
+          ?help_message: String,
+          ?logo_url: String,
+          ?official_address: Sentdm::Channels::RcsAddress,
+          ?opt_in_process_description: String,
+          ?opt_in_screenshot_url: String?,
+          ?privacy_policy_url: String,
+          ?sample_messages: ::Array[String],
+          ?sandbox: bool,
+          ?start_message: String,
+          ?stop_message: String,
+          ?terms_and_conditions_url: String,
+          ?website_url: String,
+          ?idempotency_key: String,
+          ?x_profile_id: String,
+          ?request_options: Sentdm::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          agent_use_case: Sentdm::Models::Channels::RcCreateParams::agent_use_case,
+          banner_url: 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,
+          customer_support_email: String,
+          customer_support_phone_number: String,
+          description: String,
+          display_name: String,
+          entity_type: String,
+          help_message: String,
+          logo_url: String,
+          official_address: Sentdm::Channels::RcsAddress,
+          opt_in_process_description: String,
+          opt_in_screenshot_url: String?,
+          privacy_policy_url: String,
+          sample_messages: ::Array[String],
+          sandbox: bool,
+          start_message: String,
+          stop_message: String,
+          terms_and_conditions_url: String,
+          website_url: String,
+          idempotency_key: String,
+          x_profile_id: String,
+          request_options: Sentdm::RequestOptions
+        }
+
+        type agent_use_case =
+          :VERIFICATION | :NOTIFICATIONS | :MARKETING | :MULTI_USE
+
+        module AgentUseCase
+          extend Sentdm::Internal::Type::Enum
+
+          # One-time passcodes and identity checks. Expects no reply, and is held to the strictest delivery review.
+          VERIFICATION: :VERIFICATION
+
+          # Transactional updates the recipient asked for — orders, deliveries, appointments, account activity.
+          NOTIFICATIONS: :NOTIFICATIONS
+
+          # Promotional content. Requires the clearest opt-in evidence of the four, because the carriers review consent hardest here.
+          MARKETING: :MARKETING
+
+          # More than one of the above from a single agent. Vetted against the strictest use case it covers, so declare it only if you genuinely need one agent to do several jobs.
+          MULTI_USE: :MULTI_USE
+
+          def self?.values: -> ::Array[Sentdm::Models::Channels::RcCreateParams::agent_use_case]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+module Sentdm
+  module Models
+    module Channels
+      type rcs_address =
+        {
+          city: String?,
+          country: String?,
+          postal_code: String?,
+          state: String?,
+          street: String?
+        }
+
+      class RcsAddress < Sentdm::Internal::Type::BaseModel
+        attr_accessor city: String?
+
+        attr_accessor country: String?
+
+        attr_accessor postal_code: String?
+
+        attr_accessor state: String?
+
+        attr_accessor street: String?
+
+        def initialize: (
+          ?city: String?,
+          ?country: String?,
+          ?postal_code: String?,
+          ?state: String?,
+          ?street: String?
+        ) -> void
+
+        def to_hash: -> {
+          city: String?,
+          country: String?,
+          postal_code: String?,
+          state: String?,
+          street: String?
+        }
+      end
+    end
+  end
+end