sentdm 0.44.0 → 0.46.0

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

@@ -0,0 +1,78 @@
+module Sentdm
+  module Models
+    class WhatsappChannel = Channels::WhatsappChannel
+
+    module Channels
+      type whatsapp_channel =
+        {
+          owner_business_id: String?,
+          phone_number_id: String?,
+          reason: String?,
+          reason_code: String?,
+          solution_id: String?,
+          status: Sentdm::Models::Channels::WhatsappChannel::status?,
+          waba_id: String?
+        }
+
+      class WhatsappChannel < Sentdm::Internal::Type::BaseModel
+        attr_accessor owner_business_id: String?
+
+        attr_accessor phone_number_id: String?
+
+        attr_accessor reason: String?
+
+        attr_accessor reason_code: String?
+
+        attr_accessor solution_id: String?
+
+        attr_accessor status: Sentdm::Models::Channels::WhatsappChannel::status?
+
+        attr_accessor waba_id: String?
+
+        def initialize: (
+          ?owner_business_id: String?,
+          ?phone_number_id: String?,
+          ?reason: String?,
+          ?reason_code: String?,
+          ?solution_id: String?,
+          ?status: Sentdm::Models::Channels::WhatsappChannel::status?,
+          ?waba_id: String?
+        ) -> void
+
+        def to_hash: -> {
+          owner_business_id: String?,
+          phone_number_id: String?,
+          reason: String?,
+          reason_code: String?,
+          solution_id: String?,
+          status: Sentdm::Models::Channels::WhatsappChannel::status?,
+          waba_id: 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::WhatsappChannel::status]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,56 @@
+module Sentdm
+  module Models
+    module Channels
+      type whatsapp_create_params =
+        {
+          phone_number_id: String?,
+          sandbox: bool,
+          waba_id: String,
+          idempotency_key: String,
+          x_profile_id: String
+        }
+        & Sentdm::Internal::Type::request_parameters
+
+      class WhatsappCreateParams < Sentdm::Internal::Type::BaseModel
+        extend Sentdm::Internal::Type::RequestParameters::Converter
+        include Sentdm::Internal::Type::RequestParameters
+
+        attr_accessor phone_number_id: String?
+
+        attr_reader sandbox: bool?
+
+        def sandbox=: (bool) -> bool
+
+        attr_reader waba_id: String?
+
+        def waba_id=: (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: (
+          ?phone_number_id: String?,
+          ?sandbox: bool,
+          ?waba_id: String,
+          ?idempotency_key: String,
+          ?x_profile_id: String,
+          ?request_options: Sentdm::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          phone_number_id: String?,
+          sandbox: bool,
+          waba_id: String,
+          idempotency_key: String,
+          x_profile_id: String,
+          request_options: Sentdm::RequestOptions
+        }
+      end
+    end
+  end
+end

data/sig/sentdm/models/channels_state.rbs

@@ -0,0 +1,55 @@
+module Sentdm
+  module Models
+    type channels_state =
+      {
+        customer_id: String?,
+        mms: ::Array[Sentdm::MmsMarket],
+        rcs: Sentdm::Channels::RcsAgent?,
+        sms: ::Array[Sentdm::Channels::SMSMarket],
+        voice: ::Array[Sentdm::Channels::VoiceNumber],
+        whatsapp: Sentdm::Channels::WhatsappChannel?
+      }
+
+    class ChannelsState < Sentdm::Internal::Type::BaseModel
+      attr_accessor customer_id: String?
+
+      attr_reader mms: ::Array[Sentdm::MmsMarket]?
+
+      def mms=: (::Array[Sentdm::MmsMarket]) -> ::Array[Sentdm::MmsMarket]
+
+      attr_accessor rcs: Sentdm::Channels::RcsAgent?
+
+      attr_reader sms: ::Array[Sentdm::Channels::SMSMarket]?
+
+      def sms=: (
+        ::Array[Sentdm::Channels::SMSMarket]
+      ) -> ::Array[Sentdm::Channels::SMSMarket]
+
+      attr_reader voice: ::Array[Sentdm::Channels::VoiceNumber]?
+
+      def voice=: (
+        ::Array[Sentdm::Channels::VoiceNumber]
+      ) -> ::Array[Sentdm::Channels::VoiceNumber]
+
+      attr_accessor whatsapp: Sentdm::Channels::WhatsappChannel?
+
+      def initialize: (
+        ?customer_id: String?,
+        ?mms: ::Array[Sentdm::MmsMarket],
+        ?rcs: Sentdm::Channels::RcsAgent?,
+        ?sms: ::Array[Sentdm::Channels::SMSMarket],
+        ?voice: ::Array[Sentdm::Channels::VoiceNumber],
+        ?whatsapp: Sentdm::Channels::WhatsappChannel?
+      ) -> void
+
+      def to_hash: -> {
+        customer_id: String?,
+        mms: ::Array[Sentdm::MmsMarket],
+        rcs: Sentdm::Channels::RcsAgent?,
+        sms: ::Array[Sentdm::Channels::SMSMarket],
+        voice: ::Array[Sentdm::Channels::VoiceNumber],
+        whatsapp: Sentdm::Channels::WhatsappChannel?
+      }
+    end
+  end
+end

data/sig/sentdm/models/compliance_attachment_template.rbs

@@ -0,0 +1,26 @@
+module Sentdm
+  module Models
+    type compliance_attachment_template =
+      { field_name: String, label: String?, required: bool }
+
+    class ComplianceAttachmentTemplate < Sentdm::Internal::Type::BaseModel
+      attr_reader field_name: String?
+
+      def field_name=: (String) -> String
+
+      attr_accessor label: String?
+
+      attr_reader required: bool?
+
+      def required=: (bool) -> bool
+
+      def initialize: (
+        ?field_name: String,
+        ?label: String?,
+        ?required: bool
+      ) -> void
+
+      def to_hash: -> { field_name: String, label: String?, required: bool }
+    end
+  end
+end

data/sig/sentdm/models/compliance_requirement.rbs

@@ -0,0 +1,76 @@
+module Sentdm
+  module Models
+    type compliance_requirement =
+      {
+        format_: String?,
+        item_fields: ::Array[Sentdm::ComplianceRequirement]?,
+        key: String,
+        label: String?,
+        max_items: Integer?,
+        min_length: Integer?,
+        notes: String?,
+        options: ::Array[String]?,
+        required: bool,
+        required_when: String?,
+        type: String
+      }
+
+    class ComplianceRequirement < Sentdm::Internal::Type::BaseModel
+      attr_accessor format_: String?
+
+      attr_accessor item_fields: ::Array[Sentdm::ComplianceRequirement]?
+
+      attr_reader key: String?
+
+      def key=: (String) -> String
+
+      attr_accessor label: String?
+
+      attr_accessor max_items: Integer?
+
+      attr_accessor min_length: Integer?
+
+      attr_accessor notes: String?
+
+      attr_accessor options: ::Array[String]?
+
+      attr_reader required: bool?
+
+      def required=: (bool) -> bool
+
+      attr_accessor required_when: String?
+
+      attr_reader type: String?
+
+      def type=: (String) -> String
+
+      def initialize: (
+        ?format_: String?,
+        ?item_fields: ::Array[Sentdm::ComplianceRequirement]?,
+        ?key: String,
+        ?label: String?,
+        ?max_items: Integer?,
+        ?min_length: Integer?,
+        ?notes: String?,
+        ?options: ::Array[String]?,
+        ?required: bool,
+        ?required_when: String?,
+        ?type: String
+      ) -> void
+
+      def to_hash: -> {
+        format_: String?,
+        item_fields: ::Array[Sentdm::ComplianceRequirement]?,
+        key: String,
+        label: String?,
+        max_items: Integer?,
+        min_length: Integer?,
+        notes: String?,
+        options: ::Array[String]?,
+        required: bool,
+        required_when: String?,
+        type: String
+      }
+    end
+  end
+end

data/sig/sentdm/models/compliance_requirements.rbs

@@ -0,0 +1,66 @@
+module Sentdm
+  module Models
+    type compliance_requirements =
+      {
+        channel: String,
+        country: String,
+        required: bool,
+        requirements: ::Array[Sentdm::ComplianceRequirement],
+        sender_id_pattern: String?,
+        setup: ::Array[Sentdm::ComplianceSetupStep],
+        type: String
+      }
+
+    class ComplianceRequirements < Sentdm::Internal::Type::BaseModel
+      attr_reader channel: String?
+
+      def channel=: (String) -> String
+
+      attr_reader country: String?
+
+      def country=: (String) -> String
+
+      attr_reader required: bool?
+
+      def required=: (bool) -> bool
+
+      attr_reader requirements: ::Array[Sentdm::ComplianceRequirement]?
+
+      def requirements=: (
+        ::Array[Sentdm::ComplianceRequirement]
+      ) -> ::Array[Sentdm::ComplianceRequirement]
+
+      attr_accessor sender_id_pattern: String?
+
+      attr_reader setup: ::Array[Sentdm::ComplianceSetupStep]?
+
+      def setup=: (
+        ::Array[Sentdm::ComplianceSetupStep]
+      ) -> ::Array[Sentdm::ComplianceSetupStep]
+
+      attr_reader type: String?
+
+      def type=: (String) -> String
+
+      def initialize: (
+        ?channel: String,
+        ?country: String,
+        ?required: bool,
+        ?requirements: ::Array[Sentdm::ComplianceRequirement],
+        ?sender_id_pattern: String?,
+        ?setup: ::Array[Sentdm::ComplianceSetupStep],
+        ?type: String
+      ) -> void
+
+      def to_hash: -> {
+        channel: String,
+        country: String,
+        required: bool,
+        requirements: ::Array[Sentdm::ComplianceRequirement],
+        sender_id_pattern: String?,
+        setup: ::Array[Sentdm::ComplianceSetupStep],
+        type: String
+      }
+    end
+  end
+end

data/sig/sentdm/models/compliance_retrieve_requirements_params.rbs

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

data/sig/sentdm/models/compliance_setup_step.rbs

@@ -0,0 +1,62 @@
+module Sentdm
+  module Models
+    type compliance_setup_step =
+      {
+        attachments: ::Array[Sentdm::ComplianceAttachmentTemplate]?,
+        body: top,
+        method_: String,
+        path: String,
+        resource: String,
+        step: Integer,
+        why: String
+      }
+
+    class ComplianceSetupStep < Sentdm::Internal::Type::BaseModel
+      attr_accessor attachments: ::Array[Sentdm::ComplianceAttachmentTemplate]?
+
+      attr_reader body: top?
+
+      def body=: (top) -> top
+
+      attr_reader method_: String?
+
+      def method_=: (String) -> String
+
+      attr_reader path: String?
+
+      def path=: (String) -> String
+
+      attr_reader resource: String?
+
+      def resource=: (String) -> String
+
+      attr_reader step: Integer?
+
+      def step=: (Integer) -> Integer
+
+      attr_reader why: String?
+
+      def why=: (String) -> String
+
+      def initialize: (
+        ?attachments: ::Array[Sentdm::ComplianceAttachmentTemplate]?,
+        ?body: top,
+        ?method_: String,
+        ?path: String,
+        ?resource: String,
+        ?step: Integer,
+        ?why: String
+      ) -> void
+
+      def to_hash: -> {
+        attachments: ::Array[Sentdm::ComplianceAttachmentTemplate]?,
+        body: top,
+        method_: String,
+        path: String,
+        resource: String,
+        step: Integer,
+        why: String
+      }
+    end
+  end
+end

data/sig/sentdm/models/contact_message_summary.rbs

@@ -2,7 +2,7 @@ module Sentdm
   module Models
     type contact_message_summary =
       {
-        channel_scores: ::Array[Sentdm::ContactMessageSummary::ChannelScore],
+        channel_scores: ::Array[Sentdm::ChannelScore],
         channels_used: ::Array[String],
         contact_id: String,
         first_message_at: Time?,
@@ -11,11 +11,11 @@ module Sentdm
       }
 
     class ContactMessageSummary < Sentdm::Internal::Type::BaseModel
-      attr_reader channel_scores: ::Array[Sentdm::ContactMessageSummary::ChannelScore]?
+      attr_reader channel_scores: ::Array[Sentdm::ChannelScore]?
 
       def channel_scores=: (
-        ::Array[Sentdm::ContactMessageSummary::ChannelScore]
-      ) -> ::Array[Sentdm::ContactMessageSummary::ChannelScore]
+        ::Array[Sentdm::ChannelScore]
+      ) -> ::Array[Sentdm::ChannelScore]
 
       attr_reader channels_used: ::Array[String]?
 
@@ -34,7 +34,7 @@ module Sentdm
       def message_count=: (Integer) -> Integer
 
       def initialize: (
-        ?channel_scores: ::Array[Sentdm::ContactMessageSummary::ChannelScore],
+        ?channel_scores: ::Array[Sentdm::ChannelScore],
         ?channels_used: ::Array[String],
         ?contact_id: String,
         ?first_message_at: Time?,
@@ -43,42 +43,13 @@ module Sentdm
       ) -> void
 
       def to_hash: -> {
-        channel_scores: ::Array[Sentdm::ContactMessageSummary::ChannelScore],
+        channel_scores: ::Array[Sentdm::ChannelScore],
         channels_used: ::Array[String],
         contact_id: String,
         first_message_at: Time?,
         last_message_at: Time?,
         message_count: Integer
       }
-
-      type channel_score =
-        { channel: String, fail_score: Integer, success_score: Integer }
-
-      class ChannelScore < Sentdm::Internal::Type::BaseModel
-        attr_reader channel: String?
-
-        def channel=: (String) -> String
-
-        attr_reader fail_score: Integer?
-
-        def fail_score=: (Integer) -> Integer
-
-        attr_reader success_score: Integer?
-
-        def success_score=: (Integer) -> Integer
-
-        def initialize: (
-          ?channel: String,
-          ?fail_score: Integer,
-          ?success_score: Integer
-        ) -> void
-
-        def to_hash: -> {
-          channel: String,
-          fail_score: Integer,
-          success_score: Integer
-        }
-      end
     end
   end
 end

data/sig/sentdm/models/contacts_list.rbs

@@ -0,0 +1,31 @@
+module Sentdm
+  module Models
+    type contacts_list =
+      {
+        contacts: ::Array[Sentdm::ContactResponse],
+        pagination: Sentdm::PaginationMeta
+      }
+
+    class ContactsList < Sentdm::Internal::Type::BaseModel
+      attr_reader contacts: ::Array[Sentdm::ContactResponse]?
+
+      def contacts=: (
+        ::Array[Sentdm::ContactResponse]
+      ) -> ::Array[Sentdm::ContactResponse]
+
+      attr_reader pagination: Sentdm::PaginationMeta?
+
+      def pagination=: (Sentdm::PaginationMeta) -> Sentdm::PaginationMeta
+
+      def initialize: (
+        ?contacts: ::Array[Sentdm::ContactResponse],
+        ?pagination: Sentdm::PaginationMeta
+      ) -> void
+
+      def to_hash: -> {
+        contacts: ::Array[Sentdm::ContactResponse],
+        pagination: Sentdm::PaginationMeta
+      }
+    end
+  end
+end