sentdm 0.1.0 → 0.3.0

data/rbi/sentdm/resources/webhooks.rbi

@@ -0,0 +1,218 @@
+# typed: strong
+
+module Sentdm
+  module Resources
+    class Webhooks
+      # Creates a new webhook endpoint for the authenticated customer.
+      sig do
+        params(
+          display_name: String,
+          endpoint_url: String,
+          event_types: T::Array[String],
+          retry_count: Integer,
+          test_mode: T::Boolean,
+          timeout_seconds: Integer,
+          idempotency_key: String,
+          request_options: Sentdm::RequestOptions::OrHash
+        ).returns(Sentdm::APIResponseWebhook)
+      end
+      def create(
+        # Body param
+        display_name: nil,
+        # Body param
+        endpoint_url: nil,
+        # Body param
+        event_types: nil,
+        # Body param
+        retry_count: nil,
+        # Body param: Test mode flag - when true, the operation is simulated without side
+        # effects Useful for testing integrations without actual execution
+        test_mode: nil,
+        # Body param
+        timeout_seconds: 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,
+        request_options: {}
+      )
+      end
+
+      # Retrieves a single webhook by ID for the authenticated customer.
+      sig do
+        params(
+          id: String,
+          request_options: Sentdm::RequestOptions::OrHash
+        ).returns(Sentdm::APIResponseWebhook)
+      end
+      def retrieve(id, request_options: {})
+      end
+
+      # Updates an existing webhook for the authenticated customer.
+      sig do
+        params(
+          id: String,
+          display_name: String,
+          endpoint_url: String,
+          event_types: T::Array[String],
+          retry_count: Integer,
+          test_mode: T::Boolean,
+          timeout_seconds: Integer,
+          idempotency_key: String,
+          request_options: Sentdm::RequestOptions::OrHash
+        ).returns(Sentdm::APIResponseWebhook)
+      end
+      def update(
+        # Path param
+        id,
+        # Body param
+        display_name: nil,
+        # Body param
+        endpoint_url: nil,
+        # Body param
+        event_types: nil,
+        # Body param
+        retry_count: nil,
+        # Body param: Test mode flag - when true, the operation is simulated without side
+        # effects Useful for testing integrations without actual execution
+        test_mode: nil,
+        # Body param
+        timeout_seconds: 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,
+        request_options: {}
+      )
+      end
+
+      # Retrieves a paginated list of webhooks for the authenticated customer.
+      sig do
+        params(
+          page: Integer,
+          page_size: Integer,
+          is_active: T.nilable(T::Boolean),
+          search: T.nilable(String),
+          request_options: Sentdm::RequestOptions::OrHash
+        ).returns(Sentdm::Models::WebhookListResponse)
+      end
+      def list(
+        page:,
+        page_size:,
+        is_active: nil,
+        search: nil,
+        request_options: {}
+      )
+      end
+
+      # Deletes a webhook for the authenticated customer.
+      sig do
+        params(id: String, request_options: Sentdm::RequestOptions::OrHash).void
+      end
+      def delete(id, request_options: {})
+      end
+
+      # Retrieves all available webhook event types that can be subscribed to.
+      sig do
+        params(request_options: Sentdm::RequestOptions::OrHash).returns(
+          Sentdm::Models::WebhookListEventTypesResponse
+        )
+      end
+      def list_event_types(request_options: {})
+      end
+
+      # Retrieves a paginated list of delivery events for the specified webhook.
+      sig do
+        params(
+          id: String,
+          page: Integer,
+          page_size: Integer,
+          search: T.nilable(String),
+          request_options: Sentdm::RequestOptions::OrHash
+        ).returns(Sentdm::Models::WebhookListEventsResponse)
+      end
+      def list_events(id, page:, page_size:, search: nil, request_options: {})
+      end
+
+      # Generates a new signing secret for the specified webhook. The old secret is
+      # immediately invalidated.
+      sig do
+        params(
+          id: String,
+          body: Sentdm::WebhookRotateSecretParams::Body::OrHash,
+          idempotency_key: String,
+          request_options: Sentdm::RequestOptions::OrHash
+        ).returns(Sentdm::Models::WebhookRotateSecretResponse)
+      end
+      def rotate_secret(
+        # Path param
+        id,
+        # Body param
+        body:,
+        # 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,
+        request_options: {}
+      )
+      end
+
+      # Sends a test event to the specified webhook endpoint to verify connectivity.
+      sig do
+        params(
+          id: String,
+          event_type: String,
+          test_mode: T::Boolean,
+          idempotency_key: String,
+          request_options: Sentdm::RequestOptions::OrHash
+        ).returns(Sentdm::Models::WebhookTestResponse)
+      end
+      def test_(
+        # Path param
+        id,
+        # Body param
+        event_type: nil,
+        # Body param: Test mode flag - when true, the operation is simulated without side
+        # effects Useful for testing integrations without actual execution
+        test_mode: 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,
+        request_options: {}
+      )
+      end
+
+      # Activates or deactivates a webhook for the authenticated customer.
+      sig do
+        params(
+          id: String,
+          is_active: T::Boolean,
+          test_mode: T::Boolean,
+          idempotency_key: String,
+          request_options: Sentdm::RequestOptions::OrHash
+        ).returns(Sentdm::APIResponseWebhook)
+      end
+      def toggle_status(
+        # Path param
+        id,
+        # Body param
+        is_active: nil,
+        # Body param: Test mode flag - when true, the operation is simulated without side
+        # effects Useful for testing integrations without actual execution
+        test_mode: 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,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: Sentdm::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/sig/sentdm/client.rbs

@@ -10,27 +10,28 @@ module Sentdm
 
     attr_reader api_key: String
 
-    attr_reader sender_id: String
+    attr_reader webhooks: Sentdm::Resources::Webhooks
+
+    attr_reader users: Sentdm::Resources::Users
 
     attr_reader templates: Sentdm::Resources::Templates
 
-    attr_reader contacts: Sentdm::Resources::Contacts
+    attr_reader profiles: Sentdm::Resources::Profiles
 
     attr_reader messages: Sentdm::Resources::Messages
 
-    attr_reader number_lookup: Sentdm::Resources::NumberLookup
+    attr_reader lookup: Sentdm::Resources::Lookup
 
-    attr_reader organizations: Sentdm::Resources::Organizations
+    attr_reader contacts: Sentdm::Resources::Contacts
 
-    private def auth_headers: -> ::Hash[String, String]
+    attr_reader brands: Sentdm::Resources::Brands
 
-    private def customer_api_key: -> ::Hash[String, String]
+    attr_reader me: Sentdm::Resources::Me
 
-    private def customer_sender_id: -> ::Hash[String, String]
+    private def auth_headers: -> ::Hash[String, String]
 
     def initialize: (
       ?api_key: String?,
-      ?sender_id: String?,
       ?base_url: String?,
       ?max_retries: Integer,
       ?timeout: Float,

data/sig/sentdm/models/api_error.rbs

@@ -0,0 +1,39 @@
+module Sentdm
+  module Models
+    type api_error =
+      {
+        code: String,
+        details: ::Hash[Symbol, ::Array[String]]?,
+        doc_url: String?,
+        message: String
+      }
+
+    class APIError < Sentdm::Internal::Type::BaseModel
+      attr_reader code: String?
+
+      def code=: (String) -> String
+
+      attr_accessor details: ::Hash[Symbol, ::Array[String]]?
+
+      attr_accessor doc_url: String?
+
+      attr_reader message: String?
+
+      def message=: (String) -> String
+
+      def initialize: (
+        ?code: String,
+        ?details: ::Hash[Symbol, ::Array[String]]?,
+        ?doc_url: String?,
+        ?message: String
+      ) -> void
+
+      def to_hash: -> {
+        code: String,
+        details: ::Hash[Symbol, ::Array[String]]?,
+        doc_url: String?,
+        message: String
+      }
+    end
+  end
+end

data/sig/sentdm/models/api_meta.rbs

@@ -0,0 +1,41 @@
+module Sentdm
+  module Models
+    type api_meta =
+      {
+        request_id: String,
+        response_time_ms: Integer?,
+        timestamp: Time,
+        version: String
+      }
+
+    class APIMeta < Sentdm::Internal::Type::BaseModel
+      attr_reader request_id: String?
+
+      def request_id=: (String) -> String
+
+      attr_accessor response_time_ms: Integer?
+
+      attr_reader timestamp: Time?
+
+      def timestamp=: (Time) -> Time
+
+      attr_reader version: String?
+
+      def version=: (String) -> String
+
+      def initialize: (
+        ?request_id: String,
+        ?response_time_ms: Integer?,
+        ?timestamp: Time,
+        ?version: String
+      ) -> void
+
+      def to_hash: -> {
+        request_id: String,
+        response_time_ms: Integer?,
+        timestamp: Time,
+        version: String
+      }
+    end
+  end
+end

data/sig/sentdm/models/api_response_brand_with_kyc.rbs

@@ -0,0 +1,39 @@
+module Sentdm
+  module Models
+    type api_response_brand_with_kyc =
+      {
+        data: Sentdm::BrandWithKYC?,
+        error: Sentdm::APIError?,
+        meta: Sentdm::APIMeta,
+        success: bool
+      }
+
+    class APIResponseBrandWithKYC < Sentdm::Internal::Type::BaseModel
+      attr_accessor data: Sentdm::BrandWithKYC?
+
+      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::BrandWithKYC?,
+        ?error: Sentdm::APIError?,
+        ?meta: Sentdm::APIMeta,
+        ?success: bool
+      ) -> void
+
+      def to_hash: -> {
+        data: Sentdm::BrandWithKYC?,
+        error: Sentdm::APIError?,
+        meta: Sentdm::APIMeta,
+        success: bool
+      }
+    end
+  end
+end

data/sig/sentdm/models/api_response_contact.rbs

@@ -0,0 +1,39 @@
+module Sentdm
+  module Models
+    type api_response_contact =
+      {
+        data: Sentdm::Contact?,
+        error: Sentdm::APIError?,
+        meta: Sentdm::APIMeta,
+        success: bool
+      }
+
+    class APIResponseContact < Sentdm::Internal::Type::BaseModel
+      attr_accessor data: Sentdm::Contact?
+
+      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::Contact?,
+        ?error: Sentdm::APIError?,
+        ?meta: Sentdm::APIMeta,
+        ?success: bool
+      ) -> void
+
+      def to_hash: -> {
+        data: Sentdm::Contact?,
+        error: Sentdm::APIError?,
+        meta: Sentdm::APIMeta,
+        success: bool
+      }
+    end
+  end
+end

data/sig/sentdm/models/api_response_of_profile_detail.rbs

@@ -0,0 +1,39 @@
+module Sentdm
+  module Models
+    type api_response_of_profile_detail =
+      {
+        data: Sentdm::ProfileDetail?,
+        error: Sentdm::APIError?,
+        meta: Sentdm::APIMeta,
+        success: bool
+      }
+
+    class APIResponseOfProfileDetail < Sentdm::Internal::Type::BaseModel
+      attr_accessor data: Sentdm::ProfileDetail?
+
+      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::ProfileDetail?,
+        ?error: Sentdm::APIError?,
+        ?meta: Sentdm::APIMeta,
+        ?success: bool
+      ) -> void
+
+      def to_hash: -> {
+        data: Sentdm::ProfileDetail?,
+        error: Sentdm::APIError?,
+        meta: Sentdm::APIMeta,
+        success: bool
+      }
+    end
+  end
+end

data/sig/sentdm/models/api_response_of_user.rbs

@@ -0,0 +1,39 @@
+module Sentdm
+  module Models
+    type api_response_of_user =
+      {
+        data: Sentdm::UserResponse?,
+        error: Sentdm::APIError?,
+        meta: Sentdm::APIMeta,
+        success: bool
+      }
+
+    class APIResponseOfUser < Sentdm::Internal::Type::BaseModel
+      attr_accessor data: Sentdm::UserResponse?
+
+      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::UserResponse?,
+        ?error: Sentdm::APIError?,
+        ?meta: Sentdm::APIMeta,
+        ?success: bool
+      ) -> void
+
+      def to_hash: -> {
+        data: Sentdm::UserResponse?,
+        error: Sentdm::APIError?,
+        meta: Sentdm::APIMeta,
+        success: bool
+      }
+    end
+  end
+end

data/sig/sentdm/models/api_response_template.rbs

@@ -0,0 +1,39 @@
+module Sentdm
+  module Models
+    type api_response_template =
+      {
+        data: Sentdm::Template?,
+        error: Sentdm::APIError?,
+        meta: Sentdm::APIMeta,
+        success: bool
+      }
+
+    class APIResponseTemplate < Sentdm::Internal::Type::BaseModel
+      attr_accessor data: Sentdm::Template?
+
+      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::Template?,
+        ?error: Sentdm::APIError?,
+        ?meta: Sentdm::APIMeta,
+        ?success: bool
+      ) -> void
+
+      def to_hash: -> {
+        data: Sentdm::Template?,
+        error: Sentdm::APIError?,
+        meta: Sentdm::APIMeta,
+        success: bool
+      }
+    end
+  end
+end

data/sig/sentdm/models/api_response_webhook.rbs

@@ -0,0 +1,39 @@
+module Sentdm
+  module Models
+    type api_response_webhook =
+      {
+        data: Sentdm::WebhookResponse?,
+        error: Sentdm::APIError?,
+        meta: Sentdm::APIMeta,
+        success: bool
+      }
+
+    class APIResponseWebhook < Sentdm::Internal::Type::BaseModel
+      attr_accessor data: Sentdm::WebhookResponse?
+
+      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::WebhookResponse?,
+        ?error: Sentdm::APIError?,
+        ?meta: Sentdm::APIMeta,
+        ?success: bool
+      ) -> void
+
+      def to_hash: -> {
+        data: Sentdm::WebhookResponse?,
+        error: Sentdm::APIError?,
+        meta: Sentdm::APIMeta,
+        success: bool
+      }
+    end
+  end
+end

data/sig/sentdm/models/brand_create_params.rbs

@@ -0,0 +1,36 @@
+module Sentdm
+  module Models
+    type brand_create_params =
+      { brand: Sentdm::BrandData, test_mode: bool, idempotency_key: String }
+      & Sentdm::Internal::Type::request_parameters
+
+    class BrandCreateParams < Sentdm::Internal::Type::BaseModel
+      extend Sentdm::Internal::Type::RequestParameters::Converter
+      include Sentdm::Internal::Type::RequestParameters
+
+      attr_accessor brand: Sentdm::BrandData
+
+      attr_reader test_mode: bool?
+
+      def test_mode=: (bool) -> bool
+
+      attr_reader idempotency_key: String?
+
+      def idempotency_key=: (String) -> String
+
+      def initialize: (
+        brand: Sentdm::BrandData,
+        ?test_mode: bool,
+        ?idempotency_key: String,
+        ?request_options: Sentdm::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        brand: Sentdm::BrandData,
+        test_mode: bool,
+        idempotency_key: String,
+        request_options: Sentdm::RequestOptions
+      }
+    end
+  end
+end