sentdm 0.4.0 → 0.5.0

data/rbi/sentdm/resources/profiles/campaigns.rbi

@@ -0,0 +1,127 @@
+# typed: strong
+
+module Sentdm
+  module Resources
+    class Profiles
+      # Manage organization profiles
+      class Campaigns
+        # Creates a new campaign scoped under the brand of the specified profile. Each
+        # campaign must include at least one use case with sample messages.
+        sig do
+          params(
+            profile_id: String,
+            campaign: Sentdm::Profiles::CampaignData::OrHash,
+            sandbox: T::Boolean,
+            idempotency_key: String,
+            x_profile_id: String,
+            request_options: Sentdm::RequestOptions::OrHash
+          ).returns(Sentdm::Profiles::APIResponseOfTcrCampaignWithUseCases)
+        end
+        def create(
+          # Path param: Profile ID from route
+          profile_id,
+          # Body param: Campaign data
+          campaign:,
+          # Body param: Sandbox flag - when true, the operation is simulated without side
+          # effects Useful for testing integrations without actual execution
+          sandbox: nil,
+          # Header param: Unique key to ensure idempotent request processing. Must be 1-255
+          # alphanumeric characters, hyphens, or underscores. Responses are cached for 24
+          # hours per key per customer.
+          idempotency_key: nil,
+          # Header param: Profile UUID to scope the request to a child profile. Only
+          # organization API keys can use this header. The profile must belong to the
+          # calling organization.
+          x_profile_id: nil,
+          request_options: {}
+        )
+        end
+
+        # Updates an existing campaign under the brand of the specified profile. Cannot
+        # update campaigns that have already been submitted to TCR.
+        sig do
+          params(
+            campaign_id: String,
+            profile_id: String,
+            campaign: Sentdm::Profiles::CampaignData::OrHash,
+            sandbox: T::Boolean,
+            idempotency_key: String,
+            x_profile_id: String,
+            request_options: Sentdm::RequestOptions::OrHash
+          ).returns(Sentdm::Profiles::APIResponseOfTcrCampaignWithUseCases)
+        end
+        def update(
+          # Path param: Campaign ID from route
+          campaign_id,
+          # Path param: Profile ID from route
+          profile_id:,
+          # Body param: Campaign data
+          campaign:,
+          # Body param: Sandbox flag - when true, the operation is simulated without side
+          # effects Useful for testing integrations without actual execution
+          sandbox: nil,
+          # Header param: Unique key to ensure idempotent request processing. Must be 1-255
+          # alphanumeric characters, hyphens, or underscores. Responses are cached for 24
+          # hours per key per customer.
+          idempotency_key: nil,
+          # Header param: Profile UUID to scope the request to a child profile. Only
+          # organization API keys can use this header. The profile must belong to the
+          # calling organization.
+          x_profile_id: nil,
+          request_options: {}
+        )
+        end
+
+        # Retrieves all campaigns linked to the profile's brand, including use cases and
+        # sample messages. Returns inherited campaigns if inherit_tcr_campaign=true.
+        sig do
+          params(
+            profile_id: String,
+            x_profile_id: String,
+            request_options: Sentdm::RequestOptions::OrHash
+          ).returns(Sentdm::Models::Profiles::CampaignListResponse)
+        end
+        def list(
+          # Profile ID from route
+          profile_id,
+          # Profile UUID to scope the request to a child profile. Only organization API keys
+          # can use this header. The profile must belong to the calling organization.
+          x_profile_id: nil,
+          request_options: {}
+        )
+        end
+
+        # Deletes a campaign by ID from the brand of the specified profile. The profile
+        # must belong to the authenticated organization.
+        sig do
+          params(
+            campaign_id: String,
+            profile_id: String,
+            body: Sentdm::Profiles::CampaignDeleteParams::Body::OrHash,
+            x_profile_id: String,
+            request_options: Sentdm::RequestOptions::OrHash
+          ).void
+        end
+        def delete(
+          # Path param: Campaign ID from route parameter
+          campaign_id,
+          # Path param: Profile ID from route parameter
+          profile_id:,
+          # Body param: Request to delete a campaign from a brand
+          body:,
+          # Header param: Profile UUID to scope the request to a child profile. Only
+          # organization API keys can use this header. The profile must belong to the
+          # calling organization.
+          x_profile_id: nil,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: Sentdm::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/sentdm/resources/profiles.rbi

@@ -4,6 +4,10 @@ module Sentdm
   module Resources
     # Manage organization profiles
     class Profiles
+      # Manage organization profiles
+      sig { returns(Sentdm::Resources::Profiles::Campaigns) }
+      attr_reader :campaigns
+
       # Creates a new sender profile within an organization. Profiles represent
       # different brands, departments, or use cases, each with their own messaging
       # configuration and settings. Requires admin role in the organization.
@@ -44,10 +48,9 @@ module Sentdm
         params(
           allow_contact_sharing: T::Boolean,
           allow_template_sharing: T::Boolean,
-          billing_contact:
-            T.nilable(Sentdm::ProfileCreateParams::BillingContact::OrHash),
+          billing_contact: T.nilable(Sentdm::BillingContactInfo::OrHash),
           billing_model: T.nilable(String),
-          brand: T.nilable(Sentdm::BrandData::OrHash),
+          brand: T.nilable(Sentdm::BrandsBrandData::OrHash),
           description: T.nilable(String),
           icon: T.nilable(String),
           inherit_contacts: T.nilable(T::Boolean),
@@ -55,8 +58,7 @@ module Sentdm
           inherit_tcr_campaign: T.nilable(T::Boolean),
           inherit_templates: T.nilable(T::Boolean),
           name: String,
-          payment_details:
-            T.nilable(Sentdm::ProfileCreateParams::PaymentDetails::OrHash),
+          payment_details: T.nilable(Sentdm::PaymentDetails::OrHash),
           sandbox: T::Boolean,
           short_name: T.nilable(String),
           whatsapp_business_account:
@@ -180,10 +182,9 @@ module Sentdm
           allow_contact_sharing: T.nilable(T::Boolean),
           allow_number_change_during_onboarding: T.nilable(T::Boolean),
           allow_template_sharing: T.nilable(T::Boolean),
-          billing_contact:
-            T.nilable(Sentdm::ProfileUpdateParams::BillingContact::OrHash),
+          billing_contact: T.nilable(Sentdm::BillingContactInfo::OrHash),
           billing_model: T.nilable(String),
-          brand: T.nilable(Sentdm::BrandData::OrHash),
+          brand: T.nilable(Sentdm::BrandsBrandData::OrHash),
           description: T.nilable(String),
           icon: T.nilable(String),
           inherit_contacts: T.nilable(T::Boolean),
@@ -191,8 +192,7 @@ module Sentdm
           inherit_tcr_campaign: T.nilable(T::Boolean),
           inherit_templates: T.nilable(T::Boolean),
           name: T.nilable(String),
-          payment_details:
-            T.nilable(Sentdm::ProfileUpdateParams::PaymentDetails::OrHash),
+          payment_details: T.nilable(Sentdm::PaymentDetails::OrHash),
           sandbox: T::Boolean,
           sending_phone_number: T.nilable(String),
           sending_phone_number_profile_id: T.nilable(String),
@@ -349,7 +349,7 @@ module Sentdm
           request_options: Sentdm::RequestOptions::OrHash
         ).returns(T.anything)
       end
-      def complete(
+      def complete_setup(
         # Path param: Profile ID from route
         profile_id,
         # Body param: Webhook URL to call when profile completion finishes (success or

data/sig/sentdm/client.rbs

@@ -18,14 +18,12 @@ module Sentdm
 
     attr_reader profiles: Sentdm::Resources::Profiles
 
-    attr_reader messages: Sentdm::Resources::Messages
+    attr_reader numbers: Sentdm::Resources::Numbers
 
-    attr_reader lookup: Sentdm::Resources::Lookup
+    attr_reader messages: Sentdm::Resources::Messages
 
     attr_reader contacts: Sentdm::Resources::Contacts
 
-    attr_reader brands: Sentdm::Resources::Brands
-
     attr_reader me: Sentdm::Resources::Me
 
     private def auth_headers: -> ::Hash[String, String]

data/sig/sentdm/models/{api_response_contact.rbs → api_response_of_contact.rbs}

@@ -1,15 +1,15 @@
 module Sentdm
   module Models
-    type api_response_contact =
+    type api_response_of_contact =
       {
-        data: Sentdm::Contact?,
+        data: Sentdm::ContactResponse?,
         error: Sentdm::APIError?,
         meta: Sentdm::APIMeta,
         success: bool
       }
 
-    class APIResponseContact < Sentdm::Internal::Type::BaseModel
-      attr_accessor data: Sentdm::Contact?
+    class APIResponseOfContact < Sentdm::Internal::Type::BaseModel
+      attr_accessor data: Sentdm::ContactResponse?
 
       attr_accessor error: Sentdm::APIError?
 
@@ -22,14 +22,14 @@ module Sentdm
       def success=: (bool) -> bool
 
       def initialize: (
-        ?data: Sentdm::Contact?,
+        ?data: Sentdm::ContactResponse?,
         ?error: Sentdm::APIError?,
         ?meta: Sentdm::APIMeta,
         ?success: bool
       ) -> void
 
       def to_hash: -> {
-        data: Sentdm::Contact?,
+        data: Sentdm::ContactResponse?,
         error: Sentdm::APIError?,
         meta: Sentdm::APIMeta,
         success: bool

data/sig/sentdm/models/base_dto.rbs

@@ -0,0 +1,25 @@
+module Sentdm
+  module Models
+    type base_dto = { id: String, created_at: Time, updated_at: Time? }
+
+    class BaseDto < Sentdm::Internal::Type::BaseModel
+      attr_reader id: String?
+
+      def id=: (String) -> String
+
+      attr_reader created_at: Time?
+
+      def created_at=: (Time) -> Time
+
+      attr_accessor updated_at: Time?
+
+      def initialize: (
+        ?id: String,
+        ?created_at: Time,
+        ?updated_at: Time?
+      ) -> void
+
+      def to_hash: -> { id: String, created_at: Time, updated_at: Time? }
+    end
+  end
+end

data/sig/sentdm/models/billing_contact_info.rbs

@@ -0,0 +1,30 @@
+module Sentdm
+  module Models
+    type billing_contact_info =
+      { email: String, name: String, address: String?, phone: String? }
+
+    class BillingContactInfo < Sentdm::Internal::Type::BaseModel
+      attr_accessor email: String
+
+      attr_accessor name: String
+
+      attr_accessor address: String?
+
+      attr_accessor phone: String?
+
+      def initialize: (
+        email: String,
+        name: String,
+        ?address: String?,
+        ?phone: String?
+      ) -> void
+
+      def to_hash: -> {
+        email: String,
+        name: String,
+        address: String?,
+        phone: String?
+      }
+    end
+  end
+end

data/sig/sentdm/models/{brand_data.rbs → brands_brand_data.rbs}

@@ -1,29 +1,29 @@
 module Sentdm
   module Models
-    type brand_data =
+    type brands_brand_data =
       {
-        compliance: Sentdm::BrandData::Compliance,
-        contact: Sentdm::BrandData::Contact,
-        business: Sentdm::BrandData::Business?
+        compliance: Sentdm::BrandsBrandData::Compliance,
+        contact: Sentdm::BrandsBrandData::Contact,
+        business: Sentdm::BrandsBrandData::Business?
       }
 
-    class BrandData < Sentdm::Internal::Type::BaseModel
-      attr_accessor compliance: Sentdm::BrandData::Compliance
+    class BrandsBrandData < Sentdm::Internal::Type::BaseModel
+      attr_accessor compliance: Sentdm::BrandsBrandData::Compliance
 
-      attr_accessor contact: Sentdm::BrandData::Contact
+      attr_accessor contact: Sentdm::BrandsBrandData::Contact
 
-      attr_accessor business: Sentdm::BrandData::Business?
+      attr_accessor business: Sentdm::BrandsBrandData::Business?
 
       def initialize: (
-        compliance: Sentdm::BrandData::Compliance,
-        contact: Sentdm::BrandData::Contact,
-        ?business: Sentdm::BrandData::Business?
+        compliance: Sentdm::BrandsBrandData::Compliance,
+        contact: Sentdm::BrandsBrandData::Contact,
+        ?business: Sentdm::BrandsBrandData::Business?
       ) -> void
 
       def to_hash: -> {
-        compliance: Sentdm::BrandData::Compliance,
-        contact: Sentdm::BrandData::Contact,
-        business: Sentdm::BrandData::Business?
+        compliance: Sentdm::BrandsBrandData::Compliance,
+        contact: Sentdm::BrandsBrandData::Contact,
+        business: Sentdm::BrandsBrandData::Business?
       }
 
       type compliance =
@@ -125,7 +125,7 @@ module Sentdm
           city: String?,
           country: String?,
           country_of_registration: String?,
-          entity_type: Sentdm::Models::BrandData::Business::entity_type?,
+          entity_type: Sentdm::Models::BrandsBrandData::Business::entity_type?,
           legal_name: String?,
           postal_code: String?,
           state: String?,
@@ -142,7 +142,7 @@ module Sentdm
 
         attr_accessor country_of_registration: String?
 
-        attr_accessor entity_type: Sentdm::Models::BrandData::Business::entity_type?
+        attr_accessor entity_type: Sentdm::Models::BrandsBrandData::Business::entity_type?
 
         attr_accessor legal_name: String?
 
@@ -162,7 +162,7 @@ module Sentdm
           ?city: String?,
           ?country: String?,
           ?country_of_registration: String?,
-          ?entity_type: Sentdm::Models::BrandData::Business::entity_type?,
+          ?entity_type: Sentdm::Models::BrandsBrandData::Business::entity_type?,
           ?legal_name: String?,
           ?postal_code: String?,
           ?state: String?,
@@ -176,7 +176,7 @@ module Sentdm
           city: String?,
           country: String?,
           country_of_registration: String?,
-          entity_type: Sentdm::Models::BrandData::Business::entity_type?,
+          entity_type: Sentdm::Models::BrandsBrandData::Business::entity_type?,
           legal_name: String?,
           postal_code: String?,
           state: String?,
@@ -202,7 +202,7 @@ module Sentdm
           SOLE_PROPRIETOR: :SOLE_PROPRIETOR
           GOVERNMENT: :GOVERNMENT
 
-          def self?.values: -> ::Array[Sentdm::Models::BrandData::Business::entity_type]
+          def self?.values: -> ::Array[Sentdm::Models::BrandsBrandData::Business::entity_type]
         end
       end
     end

data/sig/sentdm/models/contact_delete_params.rbs

@@ -36,7 +36,7 @@ module Sentdm
 
       type body = {  }
 
-      class Body < Sentdm::Models::MutationRequest
+      class Body < Sentdm::Models::MutationRequestBase
         def initialize: -> void
 
         def to_hash: -> {  }

data/sig/sentdm/models/contact_list_response.rbs

@@ -37,26 +37,28 @@ module Sentdm
 
       type data =
         {
-          contacts: ::Array[Sentdm::Contact],
+          contacts: ::Array[Sentdm::ContactResponse],
           pagination: Sentdm::PaginationMeta
         }
 
       class Data < Sentdm::Internal::Type::BaseModel
-        attr_reader contacts: ::Array[Sentdm::Contact]?
+        attr_reader contacts: ::Array[Sentdm::ContactResponse]?
 
-        def contacts=: (::Array[Sentdm::Contact]) -> ::Array[Sentdm::Contact]
+        def contacts=: (
+          ::Array[Sentdm::ContactResponse]
+        ) -> ::Array[Sentdm::ContactResponse]
 
         attr_reader pagination: Sentdm::PaginationMeta?
 
         def pagination=: (Sentdm::PaginationMeta) -> Sentdm::PaginationMeta
 
         def initialize: (
-          ?contacts: ::Array[Sentdm::Contact],
+          ?contacts: ::Array[Sentdm::ContactResponse],
           ?pagination: Sentdm::PaginationMeta
         ) -> void
 
         def to_hash: -> {
-          contacts: ::Array[Sentdm::Contact],
+          contacts: ::Array[Sentdm::ContactResponse],
           pagination: Sentdm::PaginationMeta
         }
       end

data/sig/sentdm/models/{contact.rbs → contact_response.rbs}

@@ -1,6 +1,6 @@
 module Sentdm
   module Models
-    type contact =
+    type contact_response =
       {
         id: String,
         available_channels: String,
@@ -18,7 +18,7 @@ module Sentdm
         updated_at: Time?
       }
 
-    class Contact < Sentdm::Internal::Type::BaseModel
+    class ContactResponse < Sentdm::Internal::Type::BaseModel
       attr_reader id: String?
 
       def id=: (String) -> String

data/sig/sentdm/models/{mutation_request.rbs → mutation_request_base.rbs}

@@ -1,8 +1,8 @@
 module Sentdm
   module Models
-    type mutation_request = { sandbox: bool }
+    type mutation_request_base = { sandbox: bool }
 
-    class MutationRequest < Sentdm::Internal::Type::BaseModel
+    class MutationRequestBase < Sentdm::Internal::Type::BaseModel
       attr_reader sandbox: bool?
 
       def sandbox=: (bool) -> bool

data/sig/sentdm/models/number_lookup_params.rbs

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

data/sig/sentdm/models/number_lookup_response.rbs

@@ -0,0 +1,100 @@
+module Sentdm
+  module Models
+    type number_lookup_response =
+      {
+        data: Sentdm::Models::NumberLookupResponse::Data?,
+        error: Sentdm::APIError?,
+        meta: Sentdm::APIMeta,
+        success: bool
+      }
+
+    class NumberLookupResponse < Sentdm::Internal::Type::BaseModel
+      attr_accessor data: Sentdm::Models::NumberLookupResponse::Data?
+
+      attr_accessor error: Sentdm::APIError?
+
+      attr_reader meta: Sentdm::APIMeta?
+
+      def meta=: (Sentdm::APIMeta) -> Sentdm::APIMeta
+
+      attr_reader success: bool?
+
+      def success=: (bool) -> bool
+
+      def initialize: (
+        ?data: Sentdm::Models::NumberLookupResponse::Data?,
+        ?error: Sentdm::APIError?,
+        ?meta: Sentdm::APIMeta,
+        ?success: bool
+      ) -> void
+
+      def to_hash: -> {
+        data: Sentdm::Models::NumberLookupResponse::Data?,
+        error: Sentdm::APIError?,
+        meta: Sentdm::APIMeta,
+        success: bool
+      }
+
+      type data =
+        {
+          carrier_name: String?,
+          country_code: String?,
+          is_ported: bool?,
+          is_valid: bool,
+          is_voip: bool?,
+          line_type: String?,
+          mobile_country_code: String?,
+          mobile_network_code: String?,
+          phone_number: String
+        }
+
+      class Data < Sentdm::Internal::Type::BaseModel
+        attr_accessor carrier_name: String?
+
+        attr_accessor country_code: String?
+
+        attr_accessor is_ported: bool?
+
+        attr_reader is_valid: bool?
+
+        def is_valid=: (bool) -> bool
+
+        attr_accessor is_voip: bool?
+
+        attr_accessor line_type: String?
+
+        attr_accessor mobile_country_code: String?
+
+        attr_accessor mobile_network_code: String?
+
+        attr_reader phone_number: String?
+
+        def phone_number=: (String) -> String
+
+        def initialize: (
+          ?carrier_name: String?,
+          ?country_code: String?,
+          ?is_ported: bool?,
+          ?is_valid: bool,
+          ?is_voip: bool?,
+          ?line_type: String?,
+          ?mobile_country_code: String?,
+          ?mobile_network_code: String?,
+          ?phone_number: String
+        ) -> void
+
+        def to_hash: -> {
+          carrier_name: String?,
+          country_code: String?,
+          is_ported: bool?,
+          is_valid: bool,
+          is_voip: bool?,
+          line_type: String?,
+          mobile_country_code: String?,
+          mobile_network_code: String?,
+          phone_number: String
+        }
+      end
+    end
+  end
+end

data/sig/sentdm/models/payment_details.rbs

@@ -0,0 +1,30 @@
+module Sentdm
+  module Models
+    type payment_details =
+      { card_number: String, cvc: String, expiry: String, zip_code: String }
+
+    class PaymentDetails < Sentdm::Internal::Type::BaseModel
+      attr_accessor card_number: String
+
+      attr_accessor cvc: String
+
+      attr_accessor expiry: String
+
+      attr_accessor zip_code: String
+
+      def initialize: (
+        card_number: String,
+        cvc: String,
+        expiry: String,
+        zip_code: String
+      ) -> void
+
+      def to_hash: -> {
+        card_number: String,
+        cvc: String,
+        expiry: String,
+        zip_code: String
+      }
+    end
+  end
+end

data/sig/sentdm/models/{profile_complete_params.rbs → profile_complete_setup_params.rbs}

@@ -1,6 +1,6 @@
 module Sentdm
   module Models
-    type profile_complete_params =
+    type profile_complete_setup_params =
       {
         profile_id: String,
         web_hook_url: String,
@@ -10,7 +10,7 @@ module Sentdm
       }
       & Sentdm::Internal::Type::request_parameters
 
-    class ProfileCompleteParams < Sentdm::Internal::Type::BaseModel
+    class ProfileCompleteSetupParams < Sentdm::Internal::Type::BaseModel
       extend Sentdm::Internal::Type::RequestParameters::Converter
       include Sentdm::Internal::Type::RequestParameters
 

data/sig/sentdm/models/profile_complete_setup_response.rbs

@@ -0,0 +1,5 @@
+module Sentdm
+  module Models
+    ProfileCompleteSetupResponse: Sentdm::Internal::Type::Converter
+  end
+end