rcs 2.0.5 → 2.0.7

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

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module PhoneNumbers
+    module Types
+      # Additional information to tailor lookup.
+      class EnhancedContactInfo < Internal::Types::Model
+        field :context, -> { String }, optional: true, nullable: false
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module PhoneNumbers
+    module Types
+      module PhoneDetailsSchemaLevel
+        extend Pinnacle::Internal::Types::Enum
+
+        BASIC = "basic"
+        ADVANCED = "advanced"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module PhoneNumbers
+    module Types
+      class PhoneNumbersGetResponse < Internal::Types::Model
+        extend Pinnacle::Internal::Types::Union
+
+        member -> { Pinnacle::Types::BasicPhoneInformation }
+        member -> { Pinnacle::Types::AdvancedPhoneInformation }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module PhoneNumbers
+    module Types
+      # Customize your lookup with additional options.
+      class RetrievePhoneNumberDetailsOptions < Internal::Types::Model
+        field :force, -> { Internal::Types::Boolean }, optional: true, nullable: false
+        field :risk, -> { Internal::Types::Boolean }, optional: true, nullable: false
+        field :enhanced_contact_info, -> { Pinnacle::PhoneNumbers::Types::EnhancedContactInfo }, optional: true, nullable: false
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module PhoneNumbers
+    module Types
+      class RetrievePhoneNumberDetailsParams < Internal::Types::Model
+        field :phone, -> { String }, optional: false, nullable: false
+        field :level, -> { Pinnacle::PhoneNumbers::Types::PhoneDetailsSchemaLevel }, optional: false, nullable: false
+        field :options, -> { Pinnacle::PhoneNumbers::Types::RetrievePhoneNumberDetailsOptions }, optional: true, nullable: false
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module PhoneNumbers
+    module Types
+      # Filter your search by digit pattern.
+      class SearchPhoneNumberByDigits < Internal::Types::Model
+        field :contains, -> { String }, optional: true, nullable: false
+        field :ends_with, -> { String }, optional: true, nullable: false, api_name: "endsWith"
+        field :starts_with, -> { String }, optional: true, nullable: false, api_name: "startsWith"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module PhoneNumbers
+    module Types
+      # Filter your search by geographic location to find numbers in specific regions. <br>
+      #
+      # Toll-free numbers ignore city and state filters.
+      class SearchPhoneNumberByLocation < Internal::Types::Model
+        field :city, -> { String }, optional: true, nullable: false
+        field :country_code, -> { String }, optional: true, nullable: false, api_name: "countryCode"
+        field :national_destination_code, -> { String }, optional: true, nullable: false, api_name: "nationalDestinationCode"
+        field :state, -> { String }, optional: true, nullable: false
+      end
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module PhoneNumbers
+    module Types
+      # Extra search settings to control how many results you get.
+      class SearchPhoneNumberOptions < Internal::Types::Model
+        field :limit, -> { Integer }, optional: true, nullable: false
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module PhoneNumbers
+    module Types
+      class SearchPhoneNumberParams < Internal::Types::Model
+        field :features, -> { Internal::Types::Array[Pinnacle::Types::PhoneFeatureEnum] }, optional: true, nullable: false
+        field :location, -> { Pinnacle::PhoneNumbers::Types::SearchPhoneNumberByLocation }, optional: true, nullable: false
+        field :number, -> { Pinnacle::PhoneNumbers::Types::SearchPhoneNumberByDigits }, optional: true, nullable: false
+        field :options, -> { Pinnacle::PhoneNumbers::Types::SearchPhoneNumberOptions }, optional: true, nullable: false
+        field :type, -> { Internal::Types::Array[Pinnacle::Types::PhoneEnum] }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/pinnacle/phone_numbers/webhook/client.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module PhoneNumbers
+    module Webhook
+      class Client
+        # @param client [Pinnacle::Internal::Http::RawClient]
+        #
+        # @return [void]
+        def initialize(client:)
+          @client = client
+        end
+
+        # Connect a webhook to your phone number to receive real-time notifications for incoming messages, delivery
+        # status updates, and other communication events.
+        #
+        # @param request_options [Hash]
+        # @param params [Pinnacle::Types::AttachWebhookParams]
+        # @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] :phone
+        #
+        # @return [Pinnacle::Types::ConfiguredWebhook]
+        def attach(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/#{params[:phone]}/attach-webhook",
+            body: Pinnacle::Types::AttachWebhookParams.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::ConfiguredWebhook.load(response.body)
+          else
+            error_class = Pinnacle::Errors::ResponseError.subclass_for_code(code)
+            raise error_class.new(response.body, code: code)
+          end
+        end
+
+        # Disconnect a webhook from your phone number to stop receiving event notifications for that specific number.
+        # <br>
+        #
+        # The webhook configuration itself remains intact and available for use with other phone numbers.
+        #
+        # @param request_options [Hash]
+        # @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] :phone
+        # @option params [String] :webhook_id
+        #
+        # @return [Pinnacle::Types::DetachedWebhookInfo]
+        def detach(request_options: {}, **params)
+          params = Pinnacle::Internal::Types::Utils.normalize_keys(params)
+          request = Pinnacle::Internal::JSON::Request.new(
+            base_url: request_options[:base_url],
+            method: "DELETE",
+            path: "phone-numbers/#{params[:phone]}/detach-webhook/#{params[:webhook_id]}",
+            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::DetachedWebhookInfo.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/pinnacle_client.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require_relative "wrapper/messages/client"
+require_relative "wrapper/tools/file_uploader"
+require_relative "wrapper/tools/client"
+
+module Pinnacle
+  # Reopen the Client class to add custom methods for webhook processing and file uploads.
+  class Client
+    # Returns an enhanced messages client with webhook processing support.
+    #
+    # @return [Pinnacle::Wrapper::Messages::Client]
+    def messages
+      @messages ||= Pinnacle::Wrapper::Messages::Client.new(client: @raw_client)
+    end
+
+    # Returns an enhanced tools client with file upload helper.
+    #
+    # @return [Pinnacle::Wrapper::Tools::Client]
+    def tools
+      @tools ||= Pinnacle::Wrapper::Tools::Client.new(client: @raw_client)
+    end
+  end
+end

data/lib/pinnacle/rcs/client.rb

@@ -0,0 +1,159 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Rcs
+    class Client
+      # @param client [Pinnacle::Internal::Http::RawClient]
+      #
+      # @return [void]
+      def initialize(client:)
+        @client = client
+      end
+
+      # Check RCS capabilities for one or more phone numbers.
+      #
+      # 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::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 [Hash[String, Pinnacle::Types::RcsCapability, nil]]
+      def get_capabilities(request_options: {}, **params)
+        params = Pinnacle::Internal::Types::Utils.normalize_keys(params)
+        body_prop_names = %i[phone_numbers]
+        body_bag = params.slice(*body_prop_names)
+
+        request = Pinnacle::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "POST",
+          path: "rcs/capabilities",
+          body: Pinnacle::Rcs::Types::RcsCapabilitiesQuery.new(body_bag).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::RcsCapabilitiesResult.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.**
+      #
+      # > **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.
+      #
+      # @param request_options [Hash]
+      # @param params [Pinnacle::Rcs::Types::RcsWhitelistRequest]
+      # @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)
+        params = Pinnacle::Internal::Types::Utils.normalize_keys(params)
+        body_prop_names = %i[agent_id phone_number]
+        body_bag = params.slice(*body_prop_names)
+
+        request = Pinnacle::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "POST",
+          path: "rcs/whitelist",
+          body: Pinnacle::Rcs::Types::RcsWhitelistRequest.new(body_bag).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::RcsWhitelistResponse.load(response.body)
+        else
+          error_class = Pinnacle::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # Generate a link for initiating an RCS conversation with your agent.
+      #
+      # Users can click these links to start conversations with your RCS agent directly
+      # from websites, emails, or other applications.
+      #
+      # @param request_options [Hash]
+      # @param params [Pinnacle::Rcs::Types::RcsLinkRequest]
+      # @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::RcsLinkResult]
+      def get_link(request_options: {}, **params)
+        params = Pinnacle::Internal::Types::Utils.normalize_keys(params)
+        body_prop_names = %i[agent_id test_mode phone_number body]
+        body_bag = params.slice(*body_prop_names)
+
+        request = Pinnacle::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "POST",
+          path: "rcs/link",
+          body: Pinnacle::Rcs::Types::RcsLinkRequest.new(body_bag).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::RcsLinkResult.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

data/lib/pinnacle/rcs/types/rcs_capabilities_query.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Rcs
+    module Types
+      class RcsCapabilitiesQuery < Internal::Types::Model
+        field :phone_numbers, -> { Internal::Types::Array[String] }, optional: false, nullable: false, api_name: "phoneNumbers"
+      end
+    end
+  end
+end

data/lib/pinnacle/rcs/types/rcs_link_request.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Rcs
+    module Types
+      class RcsLinkRequest < Internal::Types::Model
+        field :agent_id, -> { String }, optional: false, nullable: false, api_name: "agentId"
+        field :test_mode, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "testMode"
+        field :phone_number, -> { String }, optional: true, nullable: false, api_name: "phoneNumber"
+        field :body, -> { String }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/pinnacle/rcs/types/rcs_whitelist_request.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Rcs
+    module Types
+      class RcsWhitelistRequest < Internal::Types::Model
+        field :agent_id, -> { String }, optional: false, nullable: false, api_name: "agentId"
+        field :phone_number, -> { String }, optional: false, nullable: false, api_name: "phoneNumber"
+      end
+    end
+  end
+end

data/lib/pinnacle/status/client.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Status
+    class Client
+      # @param client [Pinnacle::Internal::Http::RawClient]
+      #
+      # @return [void]
+      def initialize(client:)
+        @client = client
+      end
+
+      # @return [Pinnacle::Get::Client]
+      def get
+        @get ||= Pinnacle::Status::Get::Client.new(client: @client)
+      end
+    end
+  end
+end

data/lib/pinnacle/status/get/client.rb

@@ -0,0 +1,188 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Status
+    module Get
+      class Client
+        # @param client [Pinnacle::Internal::Http::RawClient]
+        #
+        # @return [void]
+        def initialize(client:)
+          @client = client
+        end
+
+        # Retrieve a brand's status.
+        #
+        # @param request_options [Hash]
+        # @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] :brand_id
+        #
+        # @return [Pinnacle::Types::BrandStatus]
+        def brand(request_options: {}, **params)
+          params = Pinnacle::Internal::Types::Utils.normalize_keys(params)
+          request = Pinnacle::Internal::JSON::Request.new(
+            base_url: request_options[:base_url],
+            method: "GET",
+            path: "status/brand/#{params[:brand_id]}",
+            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::BrandStatus.load(response.body)
+          else
+            error_class = Pinnacle::Errors::ResponseError.subclass_for_code(code)
+            raise error_class.new(response.body, code: code)
+          end
+        end
+
+        # Retrieve a toll-free campaign's status.
+        #
+        # @param request_options [Hash]
+        # @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] :campaign_id
+        #
+        # @return [Pinnacle::Types::TollFreeCampaignStatus]
+        def toll_free(request_options: {}, **params)
+          params = Pinnacle::Internal::Types::Utils.normalize_keys(params)
+          request = Pinnacle::Internal::JSON::Request.new(
+            base_url: request_options[:base_url],
+            method: "GET",
+            path: "status/toll-free-campaign/#{params[:campaign_id]}",
+            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::TollFreeCampaignStatus.load(response.body)
+          else
+            error_class = Pinnacle::Errors::ResponseError.subclass_for_code(code)
+            raise error_class.new(response.body, code: code)
+          end
+        end
+
+        # Retrieve a 10DLC campaign's status.
+        #
+        # @param request_options [Hash]
+        # @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] :campaign_id
+        #
+        # @return [Pinnacle::Types::DlcCampaignStatus]
+        def dlc(request_options: {}, **params)
+          params = Pinnacle::Internal::Types::Utils.normalize_keys(params)
+          request = Pinnacle::Internal::JSON::Request.new(
+            base_url: request_options[:base_url],
+            method: "GET",
+            path: "status/dlc-campaign/#{params[:campaign_id]}",
+            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::DlcCampaignStatus.load(response.body)
+          else
+            error_class = Pinnacle::Errors::ResponseError.subclass_for_code(code)
+            raise error_class.new(response.body, code: code)
+          end
+        end
+
+        # Retrieve a RCS campaign's status.
+        #
+        # @param request_options [Hash]
+        # @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] :campaign_id
+        #
+        # @return [Pinnacle::Types::RcsCampaignStatus]
+        def rcs(request_options: {}, **params)
+          params = Pinnacle::Internal::Types::Utils.normalize_keys(params)
+          request = Pinnacle::Internal::JSON::Request.new(
+            base_url: request_options[:base_url],
+            method: "GET",
+            path: "status/rcs-campaign/#{params[:campaign_id]}",
+            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::RcsCampaignStatus.load(response.body)
+          else
+            error_class = Pinnacle::Errors::ResponseError.subclass_for_code(code)
+            raise error_class.new(response.body, code: code)
+          end
+        end
+
+        # Retrieve a phone number's order status and campaign attachment status. <br>
+        #
+        # Check if a number is active and ready to send messages.
+        #
+        # @param request_options [Hash]
+        # @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] :phone_number
+        #
+        # @return [Pinnacle::Types::PhoneNumberStatus]
+        def phone_number(request_options: {}, **params)
+          params = Pinnacle::Internal::Types::Utils.normalize_keys(params)
+          request = Pinnacle::Internal::JSON::Request.new(
+            base_url: request_options[:base_url],
+            method: "GET",
+            path: "status/phone-number/#{params[:phone_number]}",
+            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::PhoneNumberStatus.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