sentdm 0.3.1 → 0.5.0

data/lib/sentdm/resources/me.rb

@@ -4,11 +4,28 @@ module Sentdm
   module Resources
     # Retrieve account details
     class Me
-      # Returns the account associated with the API key. For organization API keys,
-      # returns the organization with its profiles. For profile API keys, returns the
-      # profile with its settings.
+      # Some parameter documentations has been truncated, see
+      # {Sentdm::Models::MeRetrieveParams} for more details.
       #
-      # @overload retrieve(request_options: {})
+      # Returns the account associated with the provided API key. The response includes
+      # account identity, contact information, messaging channel configuration, and —
+      # depending on the account type — either a list of child profiles or the profile's
+      # own settings.
+      #
+      # **Account types:**
+      #
+      # - `organization` — Has child profiles. The `profiles` array is populated.
+      # - `user` — Standalone account with no profiles.
+      # - `profile` — Child of an organization. Includes `organization_id`,
+      #   `short_name`, `status`, and `settings`.
+      #
+      # **Channels:** The `channels` object always includes `sms`, `whatsapp`, and
+      # `rcs`. Each channel has a `configured` boolean. Configured channels expose
+      # additional details such as `phone_number`.
+      #
+      # @overload retrieve(x_profile_id: nil, request_options: {})
+      #
+      # @param x_profile_id [String] Profile UUID to scope the request to a child profile. Only organization API keys
       #
       # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -16,11 +33,13 @@ module Sentdm
       #
       # @see Sentdm::Models::MeRetrieveParams
       def retrieve(params = {})
+        parsed, options = Sentdm::MeRetrieveParams.dump_request(params)
         @client.request(
           method: :get,
           path: "v3/me",
+          headers: parsed.transform_keys(x_profile_id: "x-profile-id"),
           model: Sentdm::Models::MeRetrieveResponse,
-          options: params[:request_options]
+          options: options
         )
       end
 

data/lib/sentdm/resources/messages.rb

@@ -4,45 +4,59 @@ module Sentdm
   module Resources
     # Send and track SMS and WhatsApp messages
     class Messages
+      # Some parameter documentations has been truncated, see
+      # {Sentdm::Models::MessageRetrieveActivitiesParams} for more details.
+      #
       # Retrieves the activity log for a specific message. Activities track the message
       # lifecycle including acceptance, processing, sending, delivery, and any errors.
       #
-      # @overload retrieve_activities(id, request_options: {})
+      # @overload retrieve_activities(id, x_profile_id: nil, request_options: {})
       #
       # @param id [String] Message ID from route parameter
       #
+      # @param x_profile_id [String] Profile UUID to scope the request to a child profile. Only organization API keys
+      #
       # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Sentdm::Models::MessageRetrieveActivitiesResponse]
       #
       # @see Sentdm::Models::MessageRetrieveActivitiesParams
       def retrieve_activities(id, params = {})
+        parsed, options = Sentdm::MessageRetrieveActivitiesParams.dump_request(params)
         @client.request(
           method: :get,
           path: ["v3/messages/%1$s/activities", id],
+          headers: parsed.transform_keys(x_profile_id: "x-profile-id"),
           model: Sentdm::Models::MessageRetrieveActivitiesResponse,
-          options: params[:request_options]
+          options: options
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Sentdm::Models::MessageRetrieveStatusParams} for more details.
+      #
       # Retrieves the current status and details of a message by ID. Includes delivery
       # status, timestamps, and error information if applicable.
       #
-      # @overload retrieve_status(id, request_options: {})
+      # @overload retrieve_status(id, x_profile_id: nil, request_options: {})
       #
       # @param id [String] Message ID
       #
+      # @param x_profile_id [String] Profile UUID to scope the request to a child profile. Only organization API keys
+      #
       # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Sentdm::Models::MessageRetrieveStatusResponse]
       #
       # @see Sentdm::Models::MessageRetrieveStatusParams
       def retrieve_status(id, params = {})
+        parsed, options = Sentdm::MessageRetrieveStatusParams.dump_request(params)
         @client.request(
           method: :get,
           path: ["v3/messages/%1$s", id],
+          headers: parsed.transform_keys(x_profile_id: "x-profile-id"),
           model: Sentdm::Models::MessageRetrieveStatusResponse,
-          options: params[:request_options]
+          options: options
         )
       end
 
@@ -55,18 +69,20 @@ module Sentdm
       # Returns immediately with per-recipient message IDs for async tracking via
       # webhooks or the GET /messages/{id} endpoint.
       #
-      # @overload send_(channel: nil, template: nil, test_mode: nil, to: nil, idempotency_key: nil, request_options: {})
+      # @overload send_(channel: nil, sandbox: nil, template: nil, to: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
       #
       # @param channel [Array<String>, nil] Body param: Channels to broadcast on, e.g. ["whatsapp", "sms"].
       #
-      # @param template [Sentdm::Models::MessageSendParams::Template] Body param: Template reference (by id or name, with optional parameters)
+      # @param sandbox [Boolean] Body param: Sandbox flag - when true, the operation is simulated without side ef
       #
-      # @param test_mode [Boolean] Body param: Test mode flag - when true, the operation is simulated without side
+      # @param template [Sentdm::Models::MessageSendParams::Template] Body param: Template reference (by id or name, with optional parameters)
       #
       # @param to [Array<String>] Body param: List of recipient phone numbers in E.164 format (multi-recipient fan
       #
       # @param idempotency_key [String] Header param: Unique key to ensure idempotent request processing. Must be 1-255
       #
+      # @param x_profile_id [String] Header param: Profile UUID to scope the request to a child profile. Only organiz
+      #
       # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Sentdm::Models::MessageSendResponse]
@@ -74,7 +90,7 @@ module Sentdm
       # @see Sentdm::Models::MessageSendParams
       def send_(params = {})
         parsed, options = Sentdm::MessageSendParams.dump_request(params)
-        header_params = {idempotency_key: "idempotency-key"}
+        header_params = {idempotency_key: "idempotency-key", x_profile_id: "x-profile-id"}
         @client.request(
           method: :post,
           path: "v3/messages",

data/lib/sentdm/resources/numbers.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Resources
+    # Manage and lookup phone numbers
+    class Numbers
+      # Some parameter documentations has been truncated, see
+      # {Sentdm::Models::NumberLookupParams} for more details.
+      #
+      # Retrieves detailed information about a phone number including carrier, line
+      # type, porting status, and VoIP detection. Uses the customer's messaging provider
+      # for rich data, with fallback to the internal index.
+      #
+      # @overload lookup(phone_number, x_profile_id: nil, request_options: {})
+      #
+      # @param phone_number [String]
+      #
+      # @param x_profile_id [String] Profile UUID to scope the request to a child profile. Only organization API keys
+      #
+      # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Sentdm::Models::NumberLookupResponse]
+      #
+      # @see Sentdm::Models::NumberLookupParams
+      def lookup(phone_number, params = {})
+        parsed, options = Sentdm::NumberLookupParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: ["v3/numbers/lookup/%1$s", phone_number],
+          headers: parsed.transform_keys(x_profile_id: "x-profile-id"),
+          model: Sentdm::Models::NumberLookupResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Sentdm::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/sentdm/resources/profiles/campaigns.rb

@@ -0,0 +1,160 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Resources
+    class Profiles
+      # Manage organization profiles
+      class Campaigns
+        # Some parameter documentations has been truncated, see
+        # {Sentdm::Models::Profiles::CampaignCreateParams} for more details.
+        #
+        # Creates a new campaign scoped under the brand of the specified profile. Each
+        # campaign must include at least one use case with sample messages.
+        #
+        # @overload create(profile_id, campaign:, sandbox: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
+        #
+        # @param profile_id [String] Path param: Profile ID from route
+        #
+        # @param campaign [Sentdm::Models::Profiles::CampaignData] Body param: Campaign data
+        #
+        # @param sandbox [Boolean] Body param: Sandbox flag - when true, the operation is simulated without side ef
+        #
+        # @param idempotency_key [String] Header param: Unique key to ensure idempotent request processing. Must be 1-255
+        #
+        # @param x_profile_id [String] Header param: Profile UUID to scope the request to a child profile. Only organiz
+        #
+        # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Sentdm::Models::Profiles::APIResponseOfTcrCampaignWithUseCases]
+        #
+        # @see Sentdm::Models::Profiles::CampaignCreateParams
+        def create(profile_id, params)
+          parsed, options = Sentdm::Profiles::CampaignCreateParams.dump_request(params)
+          header_params = {idempotency_key: "idempotency-key", x_profile_id: "x-profile-id"}
+          @client.request(
+            method: :post,
+            path: ["v3/profiles/%1$s/campaigns", profile_id],
+            headers: parsed.slice(*header_params.keys).transform_keys(header_params),
+            body: parsed.except(*header_params.keys),
+            model: Sentdm::Profiles::APIResponseOfTcrCampaignWithUseCases,
+            options: options
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {Sentdm::Models::Profiles::CampaignUpdateParams} for more details.
+        #
+        # Updates an existing campaign under the brand of the specified profile. Cannot
+        # update campaigns that have already been submitted to TCR.
+        #
+        # @overload update(campaign_id, profile_id:, campaign:, sandbox: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
+        #
+        # @param campaign_id [String] Path param: Campaign ID from route
+        #
+        # @param profile_id [String] Path param: Profile ID from route
+        #
+        # @param campaign [Sentdm::Models::Profiles::CampaignData] Body param: Campaign data
+        #
+        # @param sandbox [Boolean] Body param: Sandbox flag - when true, the operation is simulated without side ef
+        #
+        # @param idempotency_key [String] Header param: Unique key to ensure idempotent request processing. Must be 1-255
+        #
+        # @param x_profile_id [String] Header param: Profile UUID to scope the request to a child profile. Only organiz
+        #
+        # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Sentdm::Models::Profiles::APIResponseOfTcrCampaignWithUseCases]
+        #
+        # @see Sentdm::Models::Profiles::CampaignUpdateParams
+        def update(campaign_id, params)
+          parsed, options = Sentdm::Profiles::CampaignUpdateParams.dump_request(params)
+          profile_id =
+            parsed.delete(:profile_id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          header_params = {idempotency_key: "idempotency-key", x_profile_id: "x-profile-id"}
+          @client.request(
+            method: :put,
+            path: ["v3/profiles/%1$s/campaigns/%2$s", profile_id, campaign_id],
+            headers: parsed.slice(*header_params.keys).transform_keys(header_params),
+            body: parsed.except(*header_params.keys),
+            model: Sentdm::Profiles::APIResponseOfTcrCampaignWithUseCases,
+            options: options
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {Sentdm::Models::Profiles::CampaignListParams} for more details.
+        #
+        # Retrieves all campaigns linked to the profile's brand, including use cases and
+        # sample messages. Returns inherited campaigns if inherit_tcr_campaign=true.
+        #
+        # @overload list(profile_id, x_profile_id: nil, request_options: {})
+        #
+        # @param profile_id [String] Profile ID from route
+        #
+        # @param x_profile_id [String] Profile UUID to scope the request to a child profile. Only organization API keys
+        #
+        # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Sentdm::Models::Profiles::CampaignListResponse]
+        #
+        # @see Sentdm::Models::Profiles::CampaignListParams
+        def list(profile_id, params = {})
+          parsed, options = Sentdm::Profiles::CampaignListParams.dump_request(params)
+          @client.request(
+            method: :get,
+            path: ["v3/profiles/%1$s/campaigns", profile_id],
+            headers: parsed.transform_keys(x_profile_id: "x-profile-id"),
+            model: Sentdm::Models::Profiles::CampaignListResponse,
+            options: options
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {Sentdm::Models::Profiles::CampaignDeleteParams} for more details.
+        #
+        # Deletes a campaign by ID from the brand of the specified profile. The profile
+        # must belong to the authenticated organization.
+        #
+        # @overload delete(campaign_id, profile_id:, body:, x_profile_id: nil, request_options: {})
+        #
+        # @param campaign_id [String] Path param: Campaign ID from route parameter
+        #
+        # @param profile_id [String] Path param: Profile ID from route parameter
+        #
+        # @param body [Sentdm::Models::Profiles::CampaignDeleteParams::Body] Body param: Request to delete a campaign from a brand
+        #
+        # @param x_profile_id [String] Header param: Profile UUID to scope the request to a child profile. Only organiz
+        #
+        # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [nil]
+        #
+        # @see Sentdm::Models::Profiles::CampaignDeleteParams
+        def delete(campaign_id, params)
+          parsed, options = Sentdm::Profiles::CampaignDeleteParams.dump_request(params)
+          profile_id =
+            parsed.delete(:profile_id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :delete,
+            path: ["v3/profiles/%1$s/campaigns/%2$s", profile_id, campaign_id],
+            headers: parsed.except(:body).transform_keys(x_profile_id: "x-profile-id"),
+            body: parsed[:body],
+            model: NilClass,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Sentdm::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end