sentdm 0.2.0 → 0.3.0

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

@@ -0,0 +1,144 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Resources
+    class Brands
+      class Campaigns
+        # Some parameter documentations has been truncated, see
+        # {Sentdm::Models::Brands::CampaignCreateParams} for more details.
+        #
+        # Creates a new campaign scoped under a specific brand. The campaign is linked to
+        # the specified brand. Each campaign must include at least one use case with
+        # sample messages.
+        #
+        # @overload create(brand_id, campaign:, test_mode: nil, idempotency_key: nil, request_options: {})
+        #
+        # @param brand_id [String] Path param: Brand ID from route
+        #
+        # @param campaign [Sentdm::Models::Brands::CampaignData] Body param: Campaign data
+        #
+        # @param test_mode [Boolean] Body param: Test mode flag - when true, the operation is simulated without side
+        #
+        # @param idempotency_key [String] Header param: Unique key to ensure idempotent request processing. Must be 1-255
+        #
+        # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Sentdm::Models::Brands::APIResponseTcrCampaignWithUseCases]
+        #
+        # @see Sentdm::Models::Brands::CampaignCreateParams
+        def create(brand_id, params)
+          parsed, options = Sentdm::Brands::CampaignCreateParams.dump_request(params)
+          header_params = {idempotency_key: "idempotency-key"}
+          @client.request(
+            method: :post,
+            path: ["v3/brands/%1$s/campaigns", brand_id],
+            headers: parsed.slice(*header_params.keys).transform_keys(header_params),
+            body: parsed.except(*header_params.keys),
+            model: Sentdm::Brands::APIResponseTcrCampaignWithUseCases,
+            options: options
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {Sentdm::Models::Brands::CampaignUpdateParams} for more details.
+        #
+        # Updates an existing campaign scoped under a specific brand. Cannot update
+        # campaigns that have already been submitted to TCR.
+        #
+        # @overload update(campaign_id, brand_id:, campaign:, test_mode: nil, idempotency_key: nil, request_options: {})
+        #
+        # @param campaign_id [String] Path param: Campaign ID from route
+        #
+        # @param brand_id [String] Path param: Brand ID from route
+        #
+        # @param campaign [Sentdm::Models::Brands::CampaignData] Body param: Campaign data
+        #
+        # @param test_mode [Boolean] Body param: Test mode flag - when true, the operation is simulated without side
+        #
+        # @param idempotency_key [String] Header param: Unique key to ensure idempotent request processing. Must be 1-255
+        #
+        # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Sentdm::Models::Brands::APIResponseTcrCampaignWithUseCases]
+        #
+        # @see Sentdm::Models::Brands::CampaignUpdateParams
+        def update(campaign_id, params)
+          parsed, options = Sentdm::Brands::CampaignUpdateParams.dump_request(params)
+          brand_id =
+            parsed.delete(:brand_id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          header_params = {idempotency_key: "idempotency-key"}
+          @client.request(
+            method: :put,
+            path: ["v3/brands/%1$s/campaigns/%2$s", brand_id, campaign_id],
+            headers: parsed.slice(*header_params.keys).transform_keys(header_params),
+            body: parsed.except(*header_params.keys),
+            model: Sentdm::Brands::APIResponseTcrCampaignWithUseCases,
+            options: options
+          )
+        end
+
+        # Retrieves all campaigns linked to a specific brand, including their use cases
+        # and sample messages.
+        #
+        # @overload list(brand_id, request_options: {})
+        #
+        # @param brand_id [String] Brand ID from route
+        #
+        # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Sentdm::Models::Brands::CampaignListResponse]
+        #
+        # @see Sentdm::Models::Brands::CampaignListParams
+        def list(brand_id, params = {})
+          @client.request(
+            method: :get,
+            path: ["v3/brands/%1$s/campaigns", brand_id],
+            model: Sentdm::Models::Brands::CampaignListResponse,
+            options: params[:request_options]
+          )
+        end
+
+        # Deletes a campaign by ID within a specific brand. The brand must belong to the
+        # authenticated customer.
+        #
+        # @overload delete(campaign_id, brand_id:, body:, request_options: {})
+        #
+        # @param campaign_id [String] Path param: Campaign ID from route parameter
+        #
+        # @param brand_id [String] Path param: Brand ID from route parameter
+        #
+        # @param body [Sentdm::Models::Brands::CampaignDeleteParams::Body] Body param: Request to delete a campaign from a brand
+        #
+        # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [nil]
+        #
+        # @see Sentdm::Models::Brands::CampaignDeleteParams
+        def delete(campaign_id, params)
+          parsed, options = Sentdm::Brands::CampaignDeleteParams.dump_request(params)
+          brand_id =
+            parsed.delete(:brand_id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :delete,
+            path: ["v3/brands/%1$s/campaigns/%2$s", brand_id, campaign_id],
+            headers: {"content-type" => "*/*"},
+            body: parsed[:body],
+            model: NilClass,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Sentdm::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/sentdm/resources/brands.rb

@@ -0,0 +1,128 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Resources
+    class Brands
+      # @return [Sentdm::Resources::Brands::Campaigns]
+      attr_reader :campaigns
+
+      # Some parameter documentations has been truncated, see
+      # {Sentdm::Models::BrandCreateParams} for more details.
+      #
+      # Creates a new brand and associated information. This endpoint automatically sets
+      # inheritTcrBrand=false when a brand is created.
+      #
+      # @overload create(brand:, test_mode: nil, idempotency_key: nil, request_options: {})
+      #
+      # @param brand [Sentdm::Models::BrandData] Body param: Brand and KYC information
+      #
+      # @param test_mode [Boolean] Body param: Test mode flag - when true, the operation is simulated without side
+      #
+      # @param idempotency_key [String] Header param: Unique key to ensure idempotent request processing. Must be 1-255
+      #
+      # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Sentdm::Models::APIResponseBrandWithKYC]
+      #
+      # @see Sentdm::Models::BrandCreateParams
+      def create(params)
+        parsed, options = Sentdm::BrandCreateParams.dump_request(params)
+        header_params = {idempotency_key: "idempotency-key"}
+        @client.request(
+          method: :post,
+          path: "v3/brands",
+          headers: parsed.slice(*header_params.keys).transform_keys(header_params),
+          body: parsed.except(*header_params.keys),
+          model: Sentdm::APIResponseBrandWithKYC,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Sentdm::Models::BrandUpdateParams} for more details.
+      #
+      # Updates an existing brand and its associated information. Cannot update brands
+      # that have already been submitted to TCR or inherited brands.
+      #
+      # @overload update(brand_id, brand:, test_mode: nil, idempotency_key: nil, request_options: {})
+      #
+      # @param brand_id [String] Path param: Brand ID from route
+      #
+      # @param brand [Sentdm::Models::BrandData] Body param: Brand and KYC information
+      #
+      # @param test_mode [Boolean] Body param: Test mode flag - when true, the operation is simulated without side
+      #
+      # @param idempotency_key [String] Header param: Unique key to ensure idempotent request processing. Must be 1-255
+      #
+      # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Sentdm::Models::APIResponseBrandWithKYC]
+      #
+      # @see Sentdm::Models::BrandUpdateParams
+      def update(brand_id, params)
+        parsed, options = Sentdm::BrandUpdateParams.dump_request(params)
+        header_params = {idempotency_key: "idempotency-key"}
+        @client.request(
+          method: :put,
+          path: ["v3/brands/%1$s", brand_id],
+          headers: parsed.slice(*header_params.keys).transform_keys(header_params),
+          body: parsed.except(*header_params.keys),
+          model: Sentdm::APIResponseBrandWithKYC,
+          options: options
+        )
+      end
+
+      # Retrieves all brands for the authenticated customer with information in a
+      # flattened structure. Includes inherited brands if inheritTcrBrand=true.
+      #
+      # @overload list(request_options: {})
+      #
+      # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Sentdm::Models::BrandListResponse]
+      #
+      # @see Sentdm::Models::BrandListParams
+      def list(params = {})
+        @client.request(
+          method: :get,
+          path: "v3/brands",
+          model: Sentdm::Models::BrandListResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # Delete a brand by ID. The brand must belong to the authenticated customer.
+      #
+      # @overload delete(brand_id, body:, request_options: {})
+      #
+      # @param brand_id [String] Brand ID from route parameter
+      #
+      # @param body [Sentdm::Models::BrandDeleteParams::Body] Request to delete a brand
+      #
+      # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [nil]
+      #
+      # @see Sentdm::Models::BrandDeleteParams
+      def delete(brand_id, params)
+        parsed, options = Sentdm::BrandDeleteParams.dump_request(params)
+        @client.request(
+          method: :delete,
+          path: ["v3/brands/%1$s", brand_id],
+          headers: {"content-type" => "*/*"},
+          body: parsed[:body],
+          model: NilClass,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Sentdm::Client]
+      def initialize(client:)
+        @client = client
+        @campaigns = Sentdm::Resources::Brands::Campaigns.new(client: client)
+      end
+    end
+  end
+end

data/lib/sentdm/resources/contacts.rb

@@ -3,76 +3,149 @@
 module Sentdm
   module Resources
     class Contacts
-      # Retrieves a paginated list of contacts for the authenticated customer. Supports
-      # server-side pagination with configurable page size. The customer ID is extracted
-      # from the authentication token.
+      # Some parameter documentations has been truncated, see
+      # {Sentdm::Models::ContactCreateParams} for more details.
+      #
+      # Creates a new contact by phone number and associates it with the authenticated
+      # customer.
+      #
+      # @overload create(phone_number: nil, test_mode: nil, idempotency_key: nil, request_options: {})
       #
-      # @overload list(page:, page_size:, request_options: {})
+      # @param phone_number [String] Body param: Phone number of the contact to create
       #
-      # @param page [Integer] The page number (zero-indexed). Default is 0.
+      # @param test_mode [Boolean] Body param: Test mode flag - when true, the operation is simulated without side
       #
-      # @param page_size [Integer] The number of items per page. Default is 20.
+      # @param idempotency_key [String] Header param: Unique key to ensure idempotent request processing. Must be 1-255
       #
       # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Sentdm::Models::ContactListResponse]
+      # @return [Sentdm::Models::APIResponseContact]
       #
-      # @see Sentdm::Models::ContactListParams
-      def list(params)
-        parsed, options = Sentdm::ContactListParams.dump_request(params)
+      # @see Sentdm::Models::ContactCreateParams
+      def create(params = {})
+        parsed, options = Sentdm::ContactCreateParams.dump_request(params)
+        header_params = {idempotency_key: "idempotency-key"}
         @client.request(
-          method: :get,
-          path: "v2/contacts",
-          query: parsed.transform_keys(page_size: "pageSize"),
-          model: Sentdm::Models::ContactListResponse,
+          method: :post,
+          path: "v3/contacts",
+          headers: parsed.slice(*header_params.keys).transform_keys(header_params),
+          body: parsed.except(*header_params.keys),
+          model: Sentdm::APIResponseContact,
           options: options
         )
       end
 
-      # Retrieves a contact by their phone number for the authenticated customer. Phone
-      # number should be in international format (e.g., +1234567890). The customer ID is
-      # extracted from the authentication token.
+      # Retrieves a specific contact by their unique identifier. Returns detailed
+      # contact information including phone formats, available channels, and opt-out
+      # status.
       #
-      # @overload retrieve_by_phone(phone_number:, request_options: {})
+      # @overload retrieve(id, request_options: {})
       #
-      # @param phone_number [String] The phone number in international format (e.g., +1234567890)
+      # @param id [String] Contact ID from route parameter
       #
       # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Sentdm::Models::ContactListItem]
+      # @return [Sentdm::Models::APIResponseContact]
       #
-      # @see Sentdm::Models::ContactRetrieveByPhoneParams
-      def retrieve_by_phone(params)
-        parsed, options = Sentdm::ContactRetrieveByPhoneParams.dump_request(params)
+      # @see Sentdm::Models::ContactRetrieveParams
+      def retrieve(id, params = {})
         @client.request(
           method: :get,
-          path: "v2/contacts/phone",
-          query: parsed.transform_keys(phone_number: "phoneNumber"),
-          model: Sentdm::ContactListItem,
+          path: ["v3/contacts/%1$s", id],
+          model: Sentdm::APIResponseContact,
+          options: params[:request_options]
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Sentdm::Models::ContactUpdateParams} for more details.
+      #
+      # Updates a contact's default channel and/or opt-out status. Inherited contacts
+      # cannot be updated.
+      #
+      # @overload update(id, default_channel: nil, opt_out: nil, test_mode: nil, idempotency_key: nil, request_options: {})
+      #
+      # @param id [String] Path param: Contact ID from route parameter
+      #
+      # @param default_channel [String, nil] Body param: Default messaging channel: "sms" or "whatsapp"
+      #
+      # @param opt_out [Boolean, nil] Body param: Whether the contact has opted out of messaging
+      #
+      # @param test_mode [Boolean] Body param: Test mode flag - when true, the operation is simulated without side
+      #
+      # @param idempotency_key [String] Header param: Unique key to ensure idempotent request processing. Must be 1-255
+      #
+      # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Sentdm::Models::APIResponseContact]
+      #
+      # @see Sentdm::Models::ContactUpdateParams
+      def update(id, params = {})
+        parsed, options = Sentdm::ContactUpdateParams.dump_request(params)
+        header_params = {idempotency_key: "idempotency-key"}
+        @client.request(
+          method: :patch,
+          path: ["v3/contacts/%1$s", id],
+          headers: parsed.slice(*header_params.keys).transform_keys(header_params),
+          body: parsed.except(*header_params.keys),
+          model: Sentdm::APIResponseContact,
           options: options
         )
       end
 
-      # Retrieves a specific contact by their unique identifier for the authenticated
-      # customer. The customer ID is extracted from the authentication token. Returns
-      # detailed contact information including phone number and creation timestamp.
+      # Retrieves a paginated list of contacts for the authenticated customer. Supports
+      # filtering by search term, channel, or phone number.
+      #
+      # @overload list(page:, page_size:, channel: nil, phone: nil, search: nil, request_options: {})
+      #
+      # @param page [Integer] Page number (1-indexed)
+      #
+      # @param page_size [Integer]
+      #
+      # @param channel [String, nil] Optional channel filter (sms, whatsapp)
       #
-      # @overload retrieve_id(id:, request_options: {})
+      # @param phone [String, nil] Optional phone number filter (alternative to list view)
       #
-      # @param id [String] The unique identifier (GUID) of the resource to retrieve
+      # @param search [String, nil] Optional search term for filtering contacts
       #
       # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Sentdm::Models::ContactListItem]
+      # @return [Sentdm::Models::ContactListResponse]
       #
-      # @see Sentdm::Models::ContactRetrieveIDParams
-      def retrieve_id(params)
-        parsed, options = Sentdm::ContactRetrieveIDParams.dump_request(params)
+      # @see Sentdm::Models::ContactListParams
+      def list(params)
+        parsed, options = Sentdm::ContactListParams.dump_request(params)
         @client.request(
           method: :get,
-          path: "v2/contacts/id",
-          query: parsed,
-          model: Sentdm::ContactListItem,
+          path: "v3/contacts",
+          query: parsed.transform_keys(page_size: "pageSize"),
+          model: Sentdm::Models::ContactListResponse,
+          options: options
+        )
+      end
+
+      # Dissociates a contact from the authenticated customer. Inherited contacts cannot
+      # be deleted.
+      #
+      # @overload delete(id, body:, request_options: {})
+      #
+      # @param id [String] Contact ID from route parameter
+      #
+      # @param body [Sentdm::Models::ContactDeleteParams::Body] Request to delete/dissociate a contact
+      #
+      # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [nil]
+      #
+      # @see Sentdm::Models::ContactDeleteParams
+      def delete(id, params)
+        parsed, options = Sentdm::ContactDeleteParams.dump_request(params)
+        @client.request(
+          method: :delete,
+          path: ["v3/contacts/%1$s", id],
+          headers: {"content-type" => "*/*"},
+          body: parsed[:body],
+          model: NilClass,
           options: options
         )
       end

data/lib/sentdm/resources/lookup.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Resources
+    class Lookup
+      # Validates a phone number and retrieves formatting, country, and timezone
+      # information from the internal index. Provider-agnostic and works for all
+      # customers.
+      #
+      # @overload retrieve_phone_info(phone_number, request_options: {})
+      #
+      # @param phone_number [String]
+      # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Sentdm::Models::LookupRetrievePhoneInfoResponse]
+      #
+      # @see Sentdm::Models::LookupRetrievePhoneInfoParams
+      def retrieve_phone_info(phone_number, params = {})
+        @client.request(
+          method: :get,
+          path: ["v3/lookup/number/%1$s", phone_number],
+          model: Sentdm::Models::LookupRetrievePhoneInfoResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Sentdm::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/sentdm/resources/me.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Resources
+    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.
+      #
+      # @overload retrieve(request_options: {})
+      #
+      # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Sentdm::Models::MeRetrieveResponse]
+      #
+      # @see Sentdm::Models::MeRetrieveParams
+      def retrieve(params = {})
+        @client.request(
+          method: :get,
+          path: "v3/me",
+          model: Sentdm::Models::MeRetrieveResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Sentdm::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end