sentdm 0.2.0 → 0.3.0

data/rbi/sentdm/models/profile_detail.rbi

@@ -0,0 +1,273 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class ProfileDetail < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias { T.any(Sentdm::ProfileDetail, Sentdm::Internal::AnyHash) }
+
+      # Profile unique identifier
+      sig { returns(T.nilable(String)) }
+      attr_reader :id
+
+      sig { params(id: String).void }
+      attr_writer :id
+
+      # When the profile was created
+      sig { returns(T.nilable(Time)) }
+      attr_reader :created_at
+
+      sig { params(created_at: Time).void }
+      attr_writer :created_at
+
+      # Profile description
+      sig { returns(T.nilable(String)) }
+      attr_accessor :description
+
+      # Profile email (inherited from organization)
+      sig { returns(T.nilable(String)) }
+      attr_accessor :email
+
+      # Profile icon URL
+      sig { returns(T.nilable(String)) }
+      attr_accessor :icon
+
+      # Profile name
+      sig { returns(T.nilable(String)) }
+      attr_reader :name
+
+      sig { params(name: String).void }
+      attr_writer :name
+
+      # Parent organization ID
+      sig { returns(T.nilable(String)) }
+      attr_accessor :organization_id
+
+      # Profile configuration settings
+      sig { returns(T.nilable(Sentdm::ProfileDetail::Settings)) }
+      attr_reader :settings
+
+      sig { params(settings: Sentdm::ProfileDetail::Settings::OrHash).void }
+      attr_writer :settings
+
+      # Profile short name (abbreviation)
+      sig { returns(T.nilable(String)) }
+      attr_accessor :short_name
+
+      # Profile setup status: incomplete, pending_review, approved, rejected
+      sig { returns(T.nilable(String)) }
+      attr_reader :status
+
+      sig { params(status: String).void }
+      attr_writer :status
+
+      # When the profile was last updated
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :updated_at
+
+      # Detailed profile response for v3 API
+      sig do
+        params(
+          id: String,
+          created_at: Time,
+          description: T.nilable(String),
+          email: T.nilable(String),
+          icon: T.nilable(String),
+          name: String,
+          organization_id: T.nilable(String),
+          settings: Sentdm::ProfileDetail::Settings::OrHash,
+          short_name: T.nilable(String),
+          status: String,
+          updated_at: T.nilable(Time)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Profile unique identifier
+        id: nil,
+        # When the profile was created
+        created_at: nil,
+        # Profile description
+        description: nil,
+        # Profile email (inherited from organization)
+        email: nil,
+        # Profile icon URL
+        icon: nil,
+        # Profile name
+        name: nil,
+        # Parent organization ID
+        organization_id: nil,
+        # Profile configuration settings
+        settings: nil,
+        # Profile short name (abbreviation)
+        short_name: nil,
+        # Profile setup status: incomplete, pending_review, approved, rejected
+        status: nil,
+        # When the profile was last updated
+        updated_at: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            created_at: Time,
+            description: T.nilable(String),
+            email: T.nilable(String),
+            icon: T.nilable(String),
+            name: String,
+            organization_id: T.nilable(String),
+            settings: Sentdm::ProfileDetail::Settings,
+            short_name: T.nilable(String),
+            status: String,
+            updated_at: T.nilable(Time)
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Settings < Sentdm::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Sentdm::ProfileDetail::Settings, Sentdm::Internal::AnyHash)
+          end
+
+        # Whether contacts are shared across profiles in the organization
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :allow_contact_sharing
+
+        sig { params(allow_contact_sharing: T::Boolean).void }
+        attr_writer :allow_contact_sharing
+
+        # Whether number changes are allowed during onboarding
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_accessor :allow_number_change_during_onboarding
+
+        # Whether templates are shared across profiles in the organization
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :allow_template_sharing
+
+        sig { params(allow_template_sharing: T::Boolean).void }
+        attr_writer :allow_template_sharing
+
+        # Billing model: profile, organization, or profile_and_organization
+        sig { returns(T.nilable(String)) }
+        attr_reader :billing_model
+
+        sig { params(billing_model: String).void }
+        attr_writer :billing_model
+
+        # Whether this profile inherits contacts from the organization
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :inherit_contacts
+
+        sig { params(inherit_contacts: T::Boolean).void }
+        attr_writer :inherit_contacts
+
+        # Whether this profile inherits TCR brand from the organization
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :inherit_tcr_brand
+
+        sig { params(inherit_tcr_brand: T::Boolean).void }
+        attr_writer :inherit_tcr_brand
+
+        # Whether this profile inherits TCR campaign from the organization
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :inherit_tcr_campaign
+
+        sig { params(inherit_tcr_campaign: T::Boolean).void }
+        attr_writer :inherit_tcr_campaign
+
+        # Whether this profile inherits templates from the organization
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :inherit_templates
+
+        sig { params(inherit_templates: T::Boolean).void }
+        attr_writer :inherit_templates
+
+        # Direct SMS phone number
+        sig { returns(T.nilable(String)) }
+        attr_accessor :sending_phone_number
+
+        # Reference to another profile for SMS/Telnyx configuration
+        sig { returns(T.nilable(String)) }
+        attr_accessor :sending_phone_number_profile_id
+
+        # Reference to another profile for WhatsApp configuration
+        sig { returns(T.nilable(String)) }
+        attr_accessor :sending_whatsapp_number_profile_id
+
+        # Direct WhatsApp phone number
+        sig { returns(T.nilable(String)) }
+        attr_accessor :whatsapp_phone_number
+
+        # Profile configuration settings
+        sig do
+          params(
+            allow_contact_sharing: T::Boolean,
+            allow_number_change_during_onboarding: T.nilable(T::Boolean),
+            allow_template_sharing: T::Boolean,
+            billing_model: String,
+            inherit_contacts: T::Boolean,
+            inherit_tcr_brand: T::Boolean,
+            inherit_tcr_campaign: T::Boolean,
+            inherit_templates: T::Boolean,
+            sending_phone_number: T.nilable(String),
+            sending_phone_number_profile_id: T.nilable(String),
+            sending_whatsapp_number_profile_id: T.nilable(String),
+            whatsapp_phone_number: T.nilable(String)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Whether contacts are shared across profiles in the organization
+          allow_contact_sharing: nil,
+          # Whether number changes are allowed during onboarding
+          allow_number_change_during_onboarding: nil,
+          # Whether templates are shared across profiles in the organization
+          allow_template_sharing: nil,
+          # Billing model: profile, organization, or profile_and_organization
+          billing_model: nil,
+          # Whether this profile inherits contacts from the organization
+          inherit_contacts: nil,
+          # Whether this profile inherits TCR brand from the organization
+          inherit_tcr_brand: nil,
+          # Whether this profile inherits TCR campaign from the organization
+          inherit_tcr_campaign: nil,
+          # Whether this profile inherits templates from the organization
+          inherit_templates: nil,
+          # Direct SMS phone number
+          sending_phone_number: nil,
+          # Reference to another profile for SMS/Telnyx configuration
+          sending_phone_number_profile_id: nil,
+          # Reference to another profile for WhatsApp configuration
+          sending_whatsapp_number_profile_id: nil,
+          # Direct WhatsApp phone number
+          whatsapp_phone_number: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              allow_contact_sharing: T::Boolean,
+              allow_number_change_during_onboarding: T.nilable(T::Boolean),
+              allow_template_sharing: T::Boolean,
+              billing_model: String,
+              inherit_contacts: T::Boolean,
+              inherit_tcr_brand: T::Boolean,
+              inherit_tcr_campaign: T::Boolean,
+              inherit_templates: T::Boolean,
+              sending_phone_number: T.nilable(String),
+              sending_phone_number_profile_id: T.nilable(String),
+              sending_whatsapp_number_profile_id: T.nilable(String),
+              whatsapp_phone_number: T.nilable(String)
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/sentdm/models/profile_list_params.rbi

@@ -0,0 +1,27 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class ProfileListParams < Sentdm::Internal::Type::BaseModel
+      extend Sentdm::Internal::Type::RequestParameters::Converter
+      include Sentdm::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Sentdm::ProfileListParams, Sentdm::Internal::AnyHash)
+        end
+
+      sig do
+        params(request_options: Sentdm::RequestOptions::OrHash).returns(
+          T.attached_class
+        )
+      end
+      def self.new(request_options: {})
+      end
+
+      sig { override.returns({ request_options: Sentdm::RequestOptions }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/sentdm/models/profile_list_response.rbi

@@ -0,0 +1,111 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class ProfileListResponse < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Sentdm::Models::ProfileListResponse, Sentdm::Internal::AnyHash)
+        end
+
+      # The response data (null if error)
+      sig { returns(T.nilable(Sentdm::Models::ProfileListResponse::Data)) }
+      attr_reader :data
+
+      sig do
+        params(
+          data: T.nilable(Sentdm::Models::ProfileListResponse::Data::OrHash)
+        ).void
+      end
+      attr_writer :data
+
+      # Error details (null if successful)
+      sig { returns(T.nilable(Sentdm::APIError)) }
+      attr_reader :error
+
+      sig { params(error: T.nilable(Sentdm::APIError::OrHash)).void }
+      attr_writer :error
+
+      # Metadata about the request and response
+      sig { returns(T.nilable(Sentdm::APIMeta)) }
+      attr_reader :meta
+
+      sig { params(meta: Sentdm::APIMeta::OrHash).void }
+      attr_writer :meta
+
+      # Indicates whether the request was successful
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :success
+
+      sig { params(success: T::Boolean).void }
+      attr_writer :success
+
+      # Standard API response envelope for all v3 endpoints
+      sig do
+        params(
+          data: T.nilable(Sentdm::Models::ProfileListResponse::Data::OrHash),
+          error: T.nilable(Sentdm::APIError::OrHash),
+          meta: Sentdm::APIMeta::OrHash,
+          success: T::Boolean
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The response data (null if error)
+        data: nil,
+        # Error details (null if successful)
+        error: nil,
+        # Metadata about the request and response
+        meta: nil,
+        # Indicates whether the request was successful
+        success: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            data: T.nilable(Sentdm::Models::ProfileListResponse::Data),
+            error: T.nilable(Sentdm::APIError),
+            meta: Sentdm::APIMeta,
+            success: T::Boolean
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Data < Sentdm::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Sentdm::Models::ProfileListResponse::Data,
+              Sentdm::Internal::AnyHash
+            )
+          end
+
+        # List of profiles in the organization
+        sig { returns(T.nilable(T::Array[Sentdm::ProfileDetail])) }
+        attr_reader :profiles
+
+        sig { params(profiles: T::Array[Sentdm::ProfileDetail::OrHash]).void }
+        attr_writer :profiles
+
+        # The response data (null if error)
+        sig do
+          params(profiles: T::Array[Sentdm::ProfileDetail::OrHash]).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # List of profiles in the organization
+          profiles: nil
+        )
+        end
+
+        sig { override.returns({ profiles: T::Array[Sentdm::ProfileDetail] }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/sentdm/models/profile_retrieve_params.rbi

@@ -0,0 +1,27 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class ProfileRetrieveParams < Sentdm::Internal::Type::BaseModel
+      extend Sentdm::Internal::Type::RequestParameters::Converter
+      include Sentdm::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Sentdm::ProfileRetrieveParams, Sentdm::Internal::AnyHash)
+        end
+
+      sig do
+        params(request_options: Sentdm::RequestOptions::OrHash).returns(
+          T.attached_class
+        )
+      end
+      def self.new(request_options: {})
+      end
+
+      sig { override.returns({ request_options: Sentdm::RequestOptions }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/sentdm/models/profile_settings.rbi

@@ -0,0 +1,86 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class ProfileSettings < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Sentdm::ProfileSettings, Sentdm::Internal::AnyHash)
+        end
+
+      # Whether contacts are shared across profiles in the organization
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_accessor :allow_contact_sharing
+
+      # Whether templates are shared across profiles in the organization
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_accessor :allow_template_sharing
+
+      # Billing model: profile, organization, or profile_and_organization
+      sig { returns(T.nilable(String)) }
+      attr_accessor :billing_model
+
+      # Whether this profile inherits contacts from the organization
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_accessor :inherit_contacts
+
+      # Whether this profile inherits TCR brand from the organization
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_accessor :inherit_tcr_brand
+
+      # Whether this profile inherits TCR campaign from the organization
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_accessor :inherit_tcr_campaign
+
+      # Whether this profile inherits templates from the organization
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_accessor :inherit_templates
+
+      # Profile configuration settings
+      sig do
+        params(
+          allow_contact_sharing: T.nilable(T::Boolean),
+          allow_template_sharing: T.nilable(T::Boolean),
+          billing_model: T.nilable(String),
+          inherit_contacts: T.nilable(T::Boolean),
+          inherit_tcr_brand: T.nilable(T::Boolean),
+          inherit_tcr_campaign: T.nilable(T::Boolean),
+          inherit_templates: T.nilable(T::Boolean)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Whether contacts are shared across profiles in the organization
+        allow_contact_sharing: nil,
+        # Whether templates are shared across profiles in the organization
+        allow_template_sharing: nil,
+        # Billing model: profile, organization, or profile_and_organization
+        billing_model: nil,
+        # Whether this profile inherits contacts from the organization
+        inherit_contacts: nil,
+        # Whether this profile inherits TCR brand from the organization
+        inherit_tcr_brand: nil,
+        # Whether this profile inherits TCR campaign from the organization
+        inherit_tcr_campaign: nil,
+        # Whether this profile inherits templates from the organization
+        inherit_templates: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            allow_contact_sharing: T.nilable(T::Boolean),
+            allow_template_sharing: T.nilable(T::Boolean),
+            billing_model: T.nilable(String),
+            inherit_contacts: T.nilable(T::Boolean),
+            inherit_tcr_brand: T.nilable(T::Boolean),
+            inherit_tcr_campaign: T.nilable(T::Boolean),
+            inherit_templates: T.nilable(T::Boolean)
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end