rcs 2.0.5 → 2.0.8

data/lib/pinnacle/campaigns/toll_free/client.rb

@@ -0,0 +1,201 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Campaigns
+    module TollFree
+      class Client
+        # @param client [Pinnacle::Internal::Http::RawClient]
+        #
+        # @return [void]
+        def initialize(client:)
+          @client = client
+        end
+
+        # Generate campaign details based off existing campaign and the brand it's connected to.
+        #
+        # @param request_options [Hash]
+        # @param params [Pinnacle::Types::AutofillCampaignParams]
+        # @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::Campaigns::TollFree::Types::TollFreeAutofillResponse]
+        def autofill(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: "campaigns/toll-free/autofill",
+            body: Pinnacle::Types::AutofillCampaignParams.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::Campaigns::TollFree::Types::TollFreeAutofillResponse.load(response.body)
+          else
+            error_class = Pinnacle::Errors::ResponseError.subclass_for_code(code)
+            raise error_class.new(response.body, code: code)
+          end
+        end
+
+        # Retrieve Toll-Free campaign.
+        #
+        # @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::TollFreeCampaignWithExtendedBrandAndStatus]
+        def get(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: "campaigns/toll-free/#{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::TollFreeCampaignWithExtendedBrandAndStatus.load(response.body)
+          else
+            error_class = Pinnacle::Errors::ResponseError.subclass_for_code(code)
+            raise error_class.new(response.body, code: code)
+          end
+        end
+
+        # Submit your toll-free campaign for approval and activation with carriers.
+        #
+        # @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::CampaignSubmissionResult]
+        def submit(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: "campaigns/toll-free/submit/#{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::CampaignSubmissionResult.load(response.body)
+          else
+            error_class = Pinnacle::Errors::ResponseError.subclass_for_code(code)
+            raise error_class.new(response.body, code: code)
+          end
+        end
+
+        # Create a new toll-free campaign or update an existing one.
+        #
+        # <Note>
+        # **To create a new campaign:** Omit `campaignId` — one will be generated automatically.
+        #
+        # **Before you start:** Create a [brand](/api-reference/brands/upsert) first — you'll need its `id` for the
+        # [`brand`](#request.body.brand) field.
+        #
+        # All fields are **required** unless specified otherwise, and will be validated when
+        # [submitted](/api-reference/campaigns/toll-free/submit).
+        #
+        # **See the response for example values for each field.**
+        # </Note>
+        #
+        # @param request_options [Hash]
+        # @param params [Pinnacle::Campaigns::TollFree::Types::UpsertTollFreeCampaignParams]
+        # @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::TollFreeCampaignWithExtendedBrandAndStatus]
+        def upsert(request_options: {}, **params)
+          params = Pinnacle::Internal::Types::Utils.normalize_keys(params)
+          body_prop_names = %i[brand campaign_id keywords links monthly_volume name opt_in options production_message_content use_case]
+          body_bag = params.slice(*body_prop_names)
+
+          request = Pinnacle::Internal::JSON::Request.new(
+            base_url: request_options[:base_url],
+            method: "POST",
+            path: "campaigns/toll-free",
+            body: Pinnacle::Campaigns::TollFree::Types::UpsertTollFreeCampaignParams.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::TollFreeCampaignWithExtendedBrandAndStatus.load(response.body)
+          else
+            error_class = Pinnacle::Errors::ResponseError.subclass_for_code(code)
+            raise error_class.new(response.body, code: code)
+          end
+        end
+
+        # Validate your toll-free campaign configuration against carrier requirements and compliance rules.
+        #
+        # @param request_options [Hash]
+        # @param params [Pinnacle::Types::ValidateCampaignParams]
+        # @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::CampaignValidationResult]
+        def validate(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: "campaigns/toll-free/validate",
+            body: Pinnacle::Types::ValidateCampaignParams.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::CampaignValidationResult.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/campaigns/toll_free/types/toll_free_autofill_response.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Campaigns
+    module TollFree
+      module Types
+        class TollFreeAutofillResponse < Internal::Types::Model
+          field :brand, -> { String }, optional: true, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/pinnacle/campaigns/toll_free/types/toll_free_campaign_help_keywords.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Campaigns
+    module TollFree
+      module Types
+        # Help keyword settings.
+        class TollFreeCampaignHelpKeywords < Internal::Types::Model
+          field :message, -> { String }, optional: true, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/pinnacle/campaigns/toll_free/types/toll_free_campaign_keywords.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Campaigns
+    module TollFree
+      module Types
+        # Keyword response configuration.
+        class TollFreeCampaignKeywords < Internal::Types::Model
+          field :help, -> { Pinnacle::Campaigns::TollFree::Types::TollFreeCampaignHelpKeywords }, optional: true, nullable: false, api_name: "HELP"
+          field :opt_in, -> { Pinnacle::Campaigns::TollFree::Types::TollFreeCampaignOptInKeywords }, optional: true, nullable: false, api_name: "OPT_IN"
+        end
+      end
+    end
+  end
+end

data/lib/pinnacle/campaigns/toll_free/types/toll_free_campaign_links.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Campaigns
+    module TollFree
+      module Types
+        # Legal documentation links.
+        class TollFreeCampaignLinks < Internal::Types::Model
+          field :privacy_policy, -> { String }, optional: true, nullable: false, api_name: "privacyPolicy"
+          field :terms_of_service, -> { String }, optional: true, nullable: false, api_name: "termsOfService"
+        end
+      end
+    end
+  end
+end

data/lib/pinnacle/campaigns/toll_free/types/toll_free_campaign_opt_in.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Campaigns
+    module TollFree
+      module Types
+        # Opt-in method and workflow.
+        class TollFreeCampaignOptIn < Internal::Types::Model
+          field :method_, -> { Pinnacle::Types::OptInMethodEnum }, optional: true, nullable: false, api_name: "method"
+          field :url, -> { String }, optional: true, nullable: false
+          field :workflow_description, -> { String }, optional: true, nullable: false, api_name: "workflowDescription"
+        end
+      end
+    end
+  end
+end

data/lib/pinnacle/campaigns/toll_free/types/toll_free_campaign_opt_in_keywords.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Campaigns
+    module TollFree
+      module Types
+        # Opt-in keyword settings.
+        class TollFreeCampaignOptInKeywords < Internal::Types::Model
+          field :message, -> { String }, optional: true, nullable: false
+          field :keywords, -> { Internal::Types::Array[String] }, optional: true, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/pinnacle/campaigns/toll_free/types/toll_free_campaign_options.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Campaigns
+    module TollFree
+      module Types
+        # Campaign configuration options.
+        class TollFreeCampaignOptions < Internal::Types::Model
+          field :age_gated, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "ageGated"
+        end
+      end
+    end
+  end
+end

data/lib/pinnacle/campaigns/toll_free/types/toll_free_campaign_use_case.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Campaigns
+    module TollFree
+      module Types
+        # Use case classification for the campaign.
+        class TollFreeCampaignUseCase < Internal::Types::Model
+          field :summary, -> { String }, optional: true, nullable: false
+          field :value, -> { Pinnacle::Types::TollFreeCampaignUseCaseEnum }, optional: true, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/pinnacle/campaigns/toll_free/types/upsert_toll_free_campaign_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Campaigns
+    module TollFree
+      module Types
+        class UpsertTollFreeCampaignParams < Internal::Types::Model
+          field :brand, -> { String }, optional: true, nullable: false
+          field :campaign_id, -> { String }, optional: true, nullable: false, api_name: "campaignId"
+          field :keywords, -> { Pinnacle::Campaigns::TollFree::Types::TollFreeCampaignKeywords }, optional: true, nullable: false
+          field :links, -> { Pinnacle::Campaigns::TollFree::Types::TollFreeCampaignLinks }, optional: true, nullable: false
+          field :monthly_volume, -> { Pinnacle::Types::MessageVolumeEnum }, optional: true, nullable: false, api_name: "monthlyVolume"
+          field :name, -> { String }, optional: true, nullable: false
+          field :opt_in, -> { Pinnacle::Campaigns::TollFree::Types::TollFreeCampaignOptIn }, optional: true, nullable: false, api_name: "optIn"
+          field :options, -> { Pinnacle::Campaigns::TollFree::Types::TollFreeCampaignOptions }, optional: true, nullable: false
+          field :production_message_content, -> { String }, optional: true, nullable: false, api_name: "productionMessageContent"
+          field :use_case, -> { Pinnacle::Campaigns::TollFree::Types::TollFreeCampaignUseCase }, optional: true, nullable: false, api_name: "useCase"
+        end
+      end
+    end
+  end
+end

data/lib/pinnacle/client.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  class Client
+    # @param base_url [String, nil]
+    # @param api_key [String]
+    #
+    # @return [void]
+    def initialize(api_key:, base_url: nil)
+      @raw_client = Pinnacle::Internal::Http::RawClient.new(
+        base_url: base_url || Pinnacle::Environment::DEFAULT,
+        headers: {
+          "User-Agent" => "rcs/2.0.8",
+          "X-Fern-Language" => "Ruby",
+          "PINNACLE-API-KEY" => api_key.to_s
+        }
+      )
+    end
+
+    # @return [Pinnacle::Brands::Client]
+    def brands
+      @brands ||= Pinnacle::Brands::Client.new(client: @raw_client)
+    end
+
+    # @return [Pinnacle::Audiences::Client]
+    def audiences
+      @audiences ||= Pinnacle::Audiences::Client.new(client: @raw_client)
+    end
+
+    # @return [Pinnacle::Contacts::Client]
+    def contacts
+      @contacts ||= Pinnacle::Contacts::Client.new(client: @raw_client)
+    end
+
+    # @return [Pinnacle::Conversations::Client]
+    def conversations
+      @conversations ||= Pinnacle::Conversations::Client.new(client: @raw_client)
+    end
+
+    # @return [Pinnacle::Messages::Client]
+    def messages
+      @messages ||= Pinnacle::Messages::Client.new(client: @raw_client)
+    end
+
+    # @return [Pinnacle::PhoneNumbers::Client]
+    def phone_numbers
+      @phone_numbers ||= Pinnacle::PhoneNumbers::Client.new(client: @raw_client)
+    end
+
+    # @return [Pinnacle::Rcs::Client]
+    def rcs
+      @rcs ||= Pinnacle::Rcs::Client.new(client: @raw_client)
+    end
+
+    # @return [Pinnacle::Webhooks::Client]
+    def webhooks
+      @webhooks ||= Pinnacle::Webhooks::Client.new(client: @raw_client)
+    end
+
+    # @return [Pinnacle::Campaigns::Client]
+    def campaigns
+      @campaigns ||= Pinnacle::Campaigns::Client.new(client: @raw_client)
+    end
+
+    # @return [Pinnacle::Status::Client]
+    def status
+      @status ||= Pinnacle::Status::Client.new(client: @raw_client)
+    end
+
+    # @return [Pinnacle::Tools::Client]
+    def tools
+      @tools ||= Pinnacle::Tools::Client.new(client: @raw_client)
+    end
+  end
+end

data/lib/pinnacle/contacts/client.rb

@@ -0,0 +1,130 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Contacts
+    class Client
+      # @param client [Pinnacle::Internal::Http::RawClient]
+      #
+      # @return [void]
+      def initialize(client:)
+        @client = client
+      end
+
+      # Retrieve contact information for a given number.
+      #
+      # @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, nil] :id
+      # @option params [String, nil] :phone_number
+      #
+      # @return [Pinnacle::Types::Contact]
+      def get(request_options: {}, **params)
+        params = Pinnacle::Internal::Types::Utils.normalize_keys(params)
+        query_param_names = %i[id phone_number]
+        query_params = {}
+        query_params["id"] = params[:id] if params.key?(:id)
+        query_params["phoneNumber"] = params[:phone_number] if params.key?(:phone_number)
+        params.except(*query_param_names)
+
+        request = Pinnacle::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "GET",
+          path: "contacts",
+          query: query_params,
+          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::Contact.load(response.body)
+        else
+          error_class = Pinnacle::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # Create a new contact for a given phone number.
+      #
+      # @param request_options [Hash]
+      # @param params [Pinnacle::Contacts::Types::CreateContactParams]
+      # @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::ContactId]
+      def create(request_options: {}, **params)
+        params = Pinnacle::Internal::Types::Utils.normalize_keys(params)
+        body_prop_names = %i[phone_number description email name tags]
+        body_bag = params.slice(*body_prop_names)
+
+        request = Pinnacle::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "POST",
+          path: "contacts",
+          body: Pinnacle::Contacts::Types::CreateContactParams.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::ContactId.load(response.body)
+        else
+          error_class = Pinnacle::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # Update an existing contact.
+      #
+      # @param request_options [Hash]
+      # @param params [Pinnacle::Contacts::Types::UpdateContactParams]
+      # @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::UpdatedContactId]
+      def update(request_options: {}, **params)
+        params = Pinnacle::Internal::Types::Utils.normalize_keys(params)
+        body_prop_names = %i[id description email name tags]
+        body_bag = params.slice(*body_prop_names)
+
+        request = Pinnacle::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "PUT",
+          path: "contacts",
+          body: Pinnacle::Contacts::Types::UpdateContactParams.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::UpdatedContactId.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/contacts/types/contacts_get_request.rb

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

data/lib/pinnacle/contacts/types/create_contact_params.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Contacts
+    module Types
+      class CreateContactParams < Internal::Types::Model
+        field :phone_number, -> { String }, optional: false, nullable: false, api_name: "phoneNumber"
+        field :description, -> { String }, optional: true, nullable: false
+        field :email, -> { String }, optional: true, nullable: false
+        field :name, -> { String }, optional: true, nullable: false
+        field :tags, -> { Internal::Types::Array[String] }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/pinnacle/contacts/types/update_contact_params.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Contacts
+    module Types
+      class UpdateContactParams < Internal::Types::Model
+        field :id, -> { String }, optional: false, nullable: false
+        field :description, -> { String }, optional: true, nullable: false
+        field :email, -> { String }, optional: true, nullable: false
+        field :name, -> { String }, optional: true, nullable: false
+        field :tags, -> { Internal::Types::Array[String] }, optional: true, nullable: false
+      end
+    end
+  end
+end