rcs 2.0.13 → 2.0.14

data/lib/pinnacle/messages/schedules/client.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Messages
+    module Schedules
+      class Client
+        # @param client [Pinnacle::Internal::Http::RawClient]
+        #
+        # @return [void]
+        def initialize(client:)
+          @client = client
+        end
+
+        # List all scheduled messages with optional filtering and pagination. Results are sorted by creation date,
+        # newest first.
+        #
+        # @param request_options [Hash]
+        # @param params [Pinnacle::Messages::Schedules::Types::ListScheduledMessagesParams]
+        # @option request_options [String] :base_url
+        # @option request_options [Hash{String => Object}] :additional_headers
+        # @option request_options [Hash{String => Object}] :additional_query_parameters
+        # @option request_options [Hash{String => Object}] :additional_body_parameters
+        # @option request_options [Integer] :timeout_in_seconds
+        #
+        # @return [Pinnacle::Types::ListScheduledMessagesResponse]
+        def list(request_options: {}, **params)
+          params = Pinnacle::Internal::Types::Utils.normalize_keys(params)
+          request = Pinnacle::Internal::JSON::Request.new(
+            base_url: request_options[:base_url],
+            method: "POST",
+            path: "messages/schedules/list",
+            body: Pinnacle::Messages::Schedules::Types::ListScheduledMessagesParams.new(params).to_h,
+            request_options: request_options
+          )
+          begin
+            response = @client.send(request)
+          rescue Net::HTTPRequestTimeout
+            raise Pinnacle::Errors::TimeoutError
+          end
+          code = response.code.to_i
+          if code.between?(200, 299)
+            Pinnacle::Types::ListScheduledMessagesResponse.load(response.body)
+          else
+            error_class = Pinnacle::Errors::ResponseError.subclass_for_code(code)
+            raise error_class.new(response.body, code: code)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/pinnacle/messages/schedules/types/list_scheduled_messages_params.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Messages
+    module Schedules
+      module Types
+        class ListScheduledMessagesParams < Internal::Types::Model
+          field :page_index, -> { Integer }, optional: true, nullable: false, api_name: "pageIndex"
+          field :page_size, -> { Integer }, optional: true, nullable: false, api_name: "pageSize"
+          field :status, -> { Pinnacle::Messages::Schedules::Types::ListScheduledMessagesRequestStatus }, optional: true, nullable: false
+          field :schedule_type, -> { Pinnacle::Messages::Schedules::Types::ListScheduledMessagesRequestScheduleType }, optional: true, nullable: false, api_name: "scheduleType"
+          field :content, -> { String }, optional: true, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/pinnacle/messages/schedules/types/list_scheduled_messages_request_schedule_type.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Messages
+    module Schedules
+      module Types
+        module ListScheduledMessagesRequestScheduleType
+          extend Pinnacle::Internal::Types::Enum
+
+          MESSAGE = "MESSAGE"
+          BLAST = "BLAST"
+        end
+      end
+    end
+  end
+end

data/lib/pinnacle/messages/schedules/types/list_scheduled_messages_request_status.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Messages
+    module Schedules
+      module Types
+        module ListScheduledMessagesRequestStatus
+          extend Pinnacle::Internal::Types::Enum
+
+          ACTIVE = "ACTIVE"
+          CANCELLED = "CANCELLED"
+          FAILED = "FAILED"
+        end
+      end
+    end
+  end
+end

data/lib/pinnacle/messages/types/list_messages_params.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Messages
+    module Types
+      class ListMessagesParams < Internal::Types::Model
+        field :page_index, -> { Integer }, optional: true, nullable: false, api_name: "pageIndex"
+        field :page_size, -> { Integer }, optional: true, nullable: false, api_name: "pageSize"
+        field :direction, -> { Pinnacle::Messages::Types::ListMessagesRequestDirection }, optional: true, nullable: false
+        field :status, -> { Pinnacle::Messages::Types::ListMessagesRequestStatus }, optional: true, nullable: false
+        field :type, -> { Pinnacle::Messages::Types::ListMessagesRequestType }, optional: true, nullable: false
+        field :method_, -> { Pinnacle::Messages::Types::ListMessagesRequestMethod }, optional: true, nullable: false, api_name: "method"
+        field :from, -> { String }, optional: true, nullable: false
+        field :to, -> { String }, optional: true, nullable: false
+        field :content, -> { String }, optional: true, nullable: false
+        field :date_from, -> { String }, optional: true, nullable: false, api_name: "dateFrom"
+        field :date_to, -> { String }, optional: true, nullable: false, api_name: "dateTo"
+      end
+    end
+  end
+end

data/lib/pinnacle/messages/types/list_messages_request_direction.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Messages
+    module Types
+      module ListMessagesRequestDirection
+        extend Pinnacle::Internal::Types::Enum
+
+        INBOUND = "INBOUND"
+        OUTBOUND = "OUTBOUND"
+      end
+    end
+  end
+end

data/lib/pinnacle/messages/types/list_messages_request_method.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Messages
+    module Types
+      module ListMessagesRequestMethod
+        extend Pinnacle::Internal::Types::Enum
+
+        API = "API"
+        SDK = "SDK"
+        OTHER = "OTHER"
+      end
+    end
+  end
+end

data/lib/pinnacle/messages/types/list_messages_request_status.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Messages
+    module Types
+      module ListMessagesRequestStatus
+        extend Pinnacle::Internal::Types::Enum
+
+        PENDING = "PENDING"
+        SENT = "SENT"
+        SEND_FAILED = "SEND_FAILED"
+        DELIVERED = "DELIVERED"
+        DELIVERY_FAILED = "DELIVERY_FAILED"
+        RECEIVED = "RECEIVED"
+        READ = "READ"
+        QUEUED = "QUEUED"
+        FALLBACK_SENT = "FALLBACK_SENT"
+      end
+    end
+  end
+end

data/lib/pinnacle/messages/types/list_messages_request_type.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Messages
+    module Types
+      module ListMessagesRequestType
+        extend Pinnacle::Internal::Types::Enum
+
+        SMS = "SMS"
+        MMS = "MMS"
+        RCS = "RCS"
+      end
+    end
+  end
+end

data/lib/pinnacle/phone_numbers/client.rb

@@ -110,6 +110,40 @@ module Pinnacle
         end
       end
 
+      # List all owned phone numbers with pagination. Results are sorted by creation date, newest first.
+      #
+      # @param request_options [Hash]
+      # @param params [Pinnacle::PhoneNumbers::Types::ListPhoneNumbersParams]
+      # @option request_options [String] :base_url
+      # @option request_options [Hash{String => Object}] :additional_headers
+      # @option request_options [Hash{String => Object}] :additional_query_parameters
+      # @option request_options [Hash{String => Object}] :additional_body_parameters
+      # @option request_options [Integer] :timeout_in_seconds
+      #
+      # @return [Pinnacle::Types::ListPhoneNumbersResponse]
+      def list(request_options: {}, **params)
+        params = Pinnacle::Internal::Types::Utils.normalize_keys(params)
+        request = Pinnacle::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "POST",
+          path: "phone-numbers/list",
+          body: Pinnacle::PhoneNumbers::Types::ListPhoneNumbersParams.new(params).to_h,
+          request_options: request_options
+        )
+        begin
+          response = @client.send(request)
+        rescue Net::HTTPRequestTimeout
+          raise Pinnacle::Errors::TimeoutError
+        end
+        code = response.code.to_i
+        if code.between?(200, 299)
+          Pinnacle::Types::ListPhoneNumbersResponse.load(response.body)
+        else
+          error_class = Pinnacle::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
       # @return [Pinnacle::Webhook::Client]
       def webhook
         @webhook ||= Pinnacle::PhoneNumbers::Webhook::Client.new(client: @client)

data/lib/pinnacle/phone_numbers/types/list_phone_numbers_params.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module PhoneNumbers
+    module Types
+      class ListPhoneNumbersParams < Internal::Types::Model
+        field :page_index, -> { Integer }, optional: true, nullable: false, api_name: "pageIndex"
+        field :page_size, -> { Integer }, optional: true, nullable: false, api_name: "pageSize"
+      end
+    end
+  end
+end

data/lib/pinnacle/rcs/agents/client.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Rcs
+    module Agents
+      class Client
+        # @param client [Pinnacle::Internal::Http::RawClient]
+        #
+        # @return [void]
+        def initialize(client:)
+          @client = client
+        end
+
+        # List all RCS agents with pagination. Results are sorted by creation date, newest first.
+        #
+        # @param request_options [Hash]
+        # @param params [Pinnacle::Rcs::Agents::Types::ListAgentsParams]
+        # @option request_options [String] :base_url
+        # @option request_options [Hash{String => Object}] :additional_headers
+        # @option request_options [Hash{String => Object}] :additional_query_parameters
+        # @option request_options [Hash{String => Object}] :additional_body_parameters
+        # @option request_options [Integer] :timeout_in_seconds
+        #
+        # @return [Pinnacle::Types::ListAgentsResponse]
+        def list(request_options: {}, **params)
+          params = Pinnacle::Internal::Types::Utils.normalize_keys(params)
+          request = Pinnacle::Internal::JSON::Request.new(
+            base_url: request_options[:base_url],
+            method: "POST",
+            path: "rcs/agents/list",
+            body: Pinnacle::Rcs::Agents::Types::ListAgentsParams.new(params).to_h,
+            request_options: request_options
+          )
+          begin
+            response = @client.send(request)
+          rescue Net::HTTPRequestTimeout
+            raise Pinnacle::Errors::TimeoutError
+          end
+          code = response.code.to_i
+          if code.between?(200, 299)
+            Pinnacle::Types::ListAgentsResponse.load(response.body)
+          else
+            error_class = Pinnacle::Errors::ResponseError.subclass_for_code(code)
+            raise error_class.new(response.body, code: code)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/pinnacle/rcs/agents/types/list_agents_params.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Rcs
+    module Agents
+      module Types
+        class ListAgentsParams < Internal::Types::Model
+          field :page_index, -> { Integer }, optional: true, nullable: false, api_name: "pageIndex"
+          field :page_size, -> { Integer }, optional: true, nullable: false, api_name: "pageSize"
+          field :agent_type, -> { Pinnacle::Rcs::Agents::Types::ListAgentsRequestAgentType }, optional: true, nullable: false, api_name: "agentType"
+          field :name, -> { String }, optional: true, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/pinnacle/rcs/agents/types/list_agents_request_agent_type.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Rcs
+    module Agents
+      module Types
+        module ListAgentsRequestAgentType
+          extend Pinnacle::Internal::Types::Enum
+
+          PRODUCTION = "PRODUCTION"
+          TEST = "TEST"
+        end
+      end
+    end
+  end
+end

data/lib/pinnacle/rcs/client.rb

@@ -10,27 +10,27 @@ module Pinnacle
         @client = client
       end
 
-      # Check RCS capabilities for one or more phone numbers.
+      # Retrieve details of an RCS agent by its ID.
       #
-      # This endpoint allows you to verify which RCS features (cards, buttons, etc.) are supported
-      # on specific phone numbers before sending RCS messages to them.
+      # Returns the agent's configuration including display name, description, logo, hero image,
+      # contact information, and other settings.
       #
       # @param request_options [Hash]
-      # @param params [Pinnacle::Rcs::Types::RcsCapabilitiesQuery]
+      # @param params [Hash]
       # @option request_options [String] :base_url
       # @option request_options [Hash{String => Object}] :additional_headers
       # @option request_options [Hash{String => Object}] :additional_query_parameters
       # @option request_options [Hash{String => Object}] :additional_body_parameters
       # @option request_options [Integer] :timeout_in_seconds
+      # @option params [String] :agent_id
       #
-      # @return [Hash[String, Pinnacle::Types::RcsCapability, nil]]
-      def get_capabilities(request_options: {}, **params)
+      # @return [Pinnacle::Types::RcsAgentResponse]
+      def get_agent(request_options: {}, **params)
         params = Pinnacle::Internal::Types::Utils.normalize_keys(params)
         request = Pinnacle::Internal::JSON::Request.new(
           base_url: request_options[:base_url],
-          method: "POST",
-          path: "rcs/capabilities",
-          body: Pinnacle::Rcs::Types::RcsCapabilitiesQuery.new(params).to_h,
+          method: "GET",
+          path: "rcs/#{params[:agent_id]}",
           request_options: request_options
         )
         begin
@@ -40,59 +40,34 @@ module Pinnacle
         end
         code = response.code.to_i
         if code.between?(200, 299)
-          Pinnacle::Types::RcsCapabilitiesResult.load(response.body)
+          Pinnacle::Types::RcsAgentResponse.load(response.body)
         else
           error_class = Pinnacle::Errors::ResponseError.subclass_for_code(code)
           raise error_class.new(response.body, code: code)
         end
       end
 
-      # Whitelist a phone number for testing with your test RCS agent.
-      #
-      # ## Overview
-      # During development and testing, RCS agents can only send messages to whitelisted phone numbers.
-      # Use this endpoint to whitelist specific phone numbers to send and receive messages from the test agent.
-      #
-      # ## Verification Process
-      # After whitelisting a number, you'll need to complete verification:
-      #
-      # 1. Check the test device for message from "RBM Tester Management"
-      # 2. Click the "Make me a tester" button
-      # 3. Enter the separate 4-digit verification SMS code in the Pinnacle dashboard at:
-      #    ```
-      #    https://app.pinnacle.sh/dashboard/brands/{brandId}?campaignId={campaignId}&campaignType=RCS
-      #    ```
-      #
-      #  > **⚠️ Important: Re-whitelisting Numbers**
-      # >
-      # > If you whitelist a number that's already whitelisted, you'll receive a new message from "RBM Tester
-      # Management". **You must click the "Make me a tester" button again to continue sending and receiving messages.**
+      # Check RCS capabilities for one or more phone numbers.
       #
-      # > **Important Notes**
-      # >
-      # > - **Verification required:** Messages cannot be sent nor received until you have clicked the "Make me a
-      # tester" button on the test device.
-      # > - **Testing only:** This is only required for test agents. Production agents can message any RCS-enabled
-      # number.
-      # > - **Network limitations:** Whitelisting may be temporarily unavailable for some carriers but are usually
-      # restored shortly.
+      # This endpoint allows you to verify which RCS features (cards, buttons, etc.) are supported
+      # on specific phone numbers before sending RCS messages to them.
       #
       # @param request_options [Hash]
-      # @param params [Pinnacle::Rcs::Types::RcsWhitelistRequest]
+      # @param params [Pinnacle::Rcs::Types::RcsCapabilitiesQuery]
       # @option request_options [String] :base_url
       # @option request_options [Hash{String => Object}] :additional_headers
       # @option request_options [Hash{String => Object}] :additional_query_parameters
       # @option request_options [Hash{String => Object}] :additional_body_parameters
       # @option request_options [Integer] :timeout_in_seconds
       #
-      # @return [Pinnacle::Types::RcsWhitelistResponse]
-      def whitelist(request_options: {}, **params)
+      # @return [Hash[String, Pinnacle::Types::RcsCapability, nil]]
+      def get_capabilities(request_options: {}, **params)
         params = Pinnacle::Internal::Types::Utils.normalize_keys(params)
         request = Pinnacle::Internal::JSON::Request.new(
           base_url: request_options[:base_url],
           method: "POST",
-          path: "rcs/whitelist",
-          body: Pinnacle::Rcs::Types::RcsWhitelistRequest.new(params).to_h,
+          path: "rcs/capabilities",
+          body: Pinnacle::Rcs::Types::RcsCapabilitiesQuery.new(params).to_h,
           request_options: request_options
         )
         begin
@@ -102,7 +77,7 @@ module Pinnacle
         end
         code = response.code.to_i
         if code.between?(200, 299)
-          Pinnacle::Types::RcsWhitelistResponse.load(response.body)
+          Pinnacle::Types::RcsCapabilitiesResult.load(response.body)
         else
           error_class = Pinnacle::Errors::ResponseError.subclass_for_code(code)
           raise error_class.new(response.body, code: code)
@@ -145,6 +120,21 @@ module Pinnacle
           raise error_class.new(response.body, code: code)
         end
       end
+
+      # @return [Pinnacle::Agents::Client]
+      def agents
+        @agents ||= Pinnacle::Rcs::Agents::Client.new(client: @client)
+      end
+
+      # @return [Pinnacle::WhitelistedNumbers::Client]
+      def whitelisted_numbers
+        @whitelisted_numbers ||= Pinnacle::Rcs::WhitelistedNumbers::Client.new(client: @client)
+      end
+
+      # @return [Pinnacle::Test::Client]
+      def test
+        @test ||= Pinnacle::Rcs::Test::Client.new(client: @client)
+      end
     end
   end
 end