rcs 2.0.5 → 2.0.7

data/lib/pinnacle/campaigns/dlc/types/dlc_campaign_links.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Campaigns
+    module Dlc
+      module Types
+        # Legal documentation links.
+        class DlcCampaignLinks < 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/dlc/types/dlc_campaign_opt_in_keywords.rb

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

data/lib/pinnacle/campaigns/dlc/types/dlc_campaign_opt_out_keywords.rb

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

data/lib/pinnacle/campaigns/dlc/types/dlc_campaign_options.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Campaigns
+    module Dlc
+      module Types
+        # Campaign configuration options.
+        class DlcCampaignOptions < Internal::Types::Model
+          field :affiliate_marketing, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "affiliateMarketing"
+          field :age_gated, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "ageGated"
+          field :direct_lending, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "directLending"
+          field :embedded_link, -> { String }, optional: true, nullable: false, api_name: "embeddedLink"
+          field :embedded_phone, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "embeddedPhone"
+          field :number_pooling, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "numberPooling"
+        end
+      end
+    end
+  end
+end

data/lib/pinnacle/campaigns/dlc/types/dlc_campaign_use_case.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Campaigns
+    module Dlc
+      module Types
+        # Use case for the campaign.
+        class DlcCampaignUseCase < Internal::Types::Model
+          field :sub, -> { Internal::Types::Array[Pinnacle::Types::SubUseCaseEnum] }, optional: true, nullable: false
+          field :value, -> { Pinnacle::Types::DlcCampaignUseCaseEnum }, optional: true, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/pinnacle/campaigns/dlc/types/upsert_dlc_campaign_params.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Campaigns
+    module Dlc
+      module Types
+        class UpsertDlcCampaignParams < Internal::Types::Model
+          field :auto_renew, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "autoRenew"
+          field :brand, -> { String }, optional: true, nullable: false
+          field :campaign_id, -> { String }, optional: true, nullable: false, api_name: "campaignId"
+          field :description, -> { String }, optional: true, nullable: false
+          field :keywords, -> { Pinnacle::Campaigns::Dlc::Types::DlcCampaignKeywords }, optional: true, nullable: false
+          field :links, -> { Pinnacle::Campaigns::Dlc::Types::DlcCampaignLinks }, optional: true, nullable: false
+          field :message_flow, -> { String }, optional: true, nullable: false, api_name: "messageFlow"
+          field :name, -> { String }, optional: true, nullable: false
+          field :options, -> { Pinnacle::Campaigns::Dlc::Types::DlcCampaignOptions }, optional: true, nullable: false
+          field :sample_messages, -> { Internal::Types::Array[String] }, optional: true, nullable: false, api_name: "sampleMessages"
+          field :use_case, -> { Pinnacle::Campaigns::Dlc::Types::DlcCampaignUseCase }, optional: true, nullable: false, api_name: "useCase"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,199 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Campaigns
+    module Rcs
+      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::Rcs::Types::RcsAutofillResponse]
+        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/rcs/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::Rcs::Types::RcsAutofillResponse.load(response.body)
+          else
+            error_class = Pinnacle::Errors::ResponseError.subclass_for_code(code)
+            raise error_class.new(response.body, code: code)
+          end
+        end
+
+        # Retrieve RCS 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::ExtendedRcsCampaign]
+        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/rcs/#{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::ExtendedRcsCampaign.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 RCS 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/rcs/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 RCS 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/rcs/submit).
+        # </Note>
+        #
+        # @param request_options [Hash]
+        # @param params [Pinnacle::Campaigns::Rcs::Types::UpsertRcsCampaignParams]
+        # @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::ExtendedRcsCampaign]
+        def upsert(request_options: {}, **params)
+          params = Pinnacle::Internal::Types::Utils.normalize_keys(params)
+          body_prop_names = %i[agent brand campaign_id expected_agent_responses links use_case opt_in_terms_and_conditions messaging_type carrier_description keywords traffic agent_triggers interaction_description is_conversational cta_language demo_trigger]
+          body_bag = params.slice(*body_prop_names)
+
+          request = Pinnacle::Internal::JSON::Request.new(
+            base_url: request_options[:base_url],
+            method: "POST",
+            path: "campaigns/rcs",
+            body: Pinnacle::Campaigns::Rcs::Types::UpsertRcsCampaignParams.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::ExtendedRcsCampaign.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 RCS 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/rcs/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/rcs/types/rcs_agent.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Campaigns
+    module Rcs
+      module Types
+        # Create an agent for the campaign.
+        class RcsAgent < Internal::Types::Model
+          field :color, -> { String }, optional: true, nullable: false
+          field :description, -> { String }, optional: true, nullable: false
+          field :emails, -> { Internal::Types::Array[Pinnacle::Campaigns::Rcs::Types::RcsAgentEmail] }, optional: true, nullable: false
+          field :hero_url, -> { String }, optional: true, nullable: false, api_name: "heroUrl"
+          field :icon_url, -> { String }, optional: true, nullable: false, api_name: "iconUrl"
+          field :name, -> { String }, optional: true, nullable: false
+          field :phones, -> { Internal::Types::Array[Pinnacle::Campaigns::Rcs::Types::RcsAgentPhone] }, optional: true, nullable: false
+          field :websites, -> { Internal::Types::Array[Pinnacle::Campaigns::Rcs::Types::RcsAgentWebsite] }, optional: true, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/pinnacle/campaigns/rcs/types/rcs_agent_email.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Campaigns
+    module Rcs
+      module Types
+        class RcsAgentEmail < Internal::Types::Model
+          field :email, -> { String }, optional: true, nullable: false
+          field :label, -> { String }, optional: true, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/pinnacle/campaigns/rcs/types/rcs_agent_phone.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Campaigns
+    module Rcs
+      module Types
+        class RcsAgentPhone < Internal::Types::Model
+          field :label, -> { String }, optional: true, nullable: false
+          field :phone, -> { String }, optional: true, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/pinnacle/campaigns/rcs/types/rcs_agent_website.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Campaigns
+    module Rcs
+      module Types
+        class RcsAgentWebsite < Internal::Types::Model
+          field :label, -> { String }, optional: true, nullable: false
+          field :url, -> { String }, optional: true, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/pinnacle/campaigns/rcs/types/rcs_autofill_response.rb

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

data/lib/pinnacle/campaigns/rcs/types/rcs_campaign_help_keywords.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Campaigns
+    module Rcs
+      module Types
+        class RcsCampaignHelpKeywords < 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/rcs/types/rcs_campaign_keywords.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Campaigns
+    module Rcs
+      module Types
+        class RcsCampaignKeywords < Internal::Types::Model
+          field :help, -> { Pinnacle::Campaigns::Rcs::Types::RcsCampaignHelpKeywords }, optional: true, nullable: false, api_name: "HELP"
+          field :opt_in, -> { Pinnacle::Campaigns::Rcs::Types::RcsCampaignOptInKeywords }, optional: true, nullable: false, api_name: "OPT_IN"
+          field :opt_out, -> { Pinnacle::Campaigns::Rcs::Types::RcsCampaignOptOutKeywords }, optional: true, nullable: false, api_name: "OPT_OUT"
+        end
+      end
+    end
+  end
+end

data/lib/pinnacle/campaigns/rcs/types/rcs_campaign_opt_in_keywords.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Campaigns
+    module Rcs
+      module Types
+        class RcsCampaignOptInKeywords < 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/rcs/types/rcs_campaign_opt_out_keywords.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Campaigns
+    module Rcs
+      module Types
+        class RcsCampaignOptOutKeywords < 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/rcs/types/rcs_campaign_traffic.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Campaigns
+    module Rcs
+      module Types
+        class RcsCampaignTraffic < Internal::Types::Model
+          field :monthly_website, -> { Integer }, optional: true, nullable: false, api_name: "monthlyWebsite"
+          field :monthly_rcs_estimate, -> { Integer }, optional: true, nullable: false, api_name: "monthlyRcsEstimate"
+        end
+      end
+    end
+  end
+end

data/lib/pinnacle/campaigns/rcs/types/rcs_links.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Campaigns
+    module Rcs
+      module Types
+        # Legal documentation links.
+        class RcsLinks < 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/rcs/types/rcs_use_case.rb

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

data/lib/pinnacle/campaigns/rcs/types/upsert_rcs_campaign_params.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Campaigns
+    module Rcs
+      module Types
+        class UpsertRcsCampaignParams < Internal::Types::Model
+          field :agent, -> { Pinnacle::Campaigns::Rcs::Types::RcsAgent }, optional: true, nullable: false
+          field :brand, -> { String }, optional: true, nullable: false
+          field :campaign_id, -> { String }, optional: true, nullable: false, api_name: "campaignId"
+          field :expected_agent_responses, -> { Internal::Types::Array[String] }, optional: true, nullable: false, api_name: "expectedAgentResponses"
+          field :links, -> { Pinnacle::Campaigns::Rcs::Types::RcsLinks }, optional: true, nullable: false
+          field :use_case, -> { Pinnacle::Campaigns::Rcs::Types::RcsUseCase }, optional: true, nullable: false, api_name: "useCase"
+          field :opt_in_terms_and_conditions, -> { String }, optional: true, nullable: false, api_name: "optInTermsAndConditions"
+          field :messaging_type, -> { Pinnacle::Types::RcsMessagingTypeEnum }, optional: true, nullable: false, api_name: "messagingType"
+          field :carrier_description, -> { String }, optional: true, nullable: false, api_name: "carrierDescription"
+          field :keywords, -> { Pinnacle::Campaigns::Rcs::Types::RcsCampaignKeywords }, optional: true, nullable: false
+          field :traffic, -> { Pinnacle::Campaigns::Rcs::Types::RcsCampaignTraffic }, optional: true, nullable: false
+          field :agent_triggers, -> { String }, optional: true, nullable: false, api_name: "agentTriggers"
+          field :interaction_description, -> { String }, optional: true, nullable: false, api_name: "interactionDescription"
+          field :is_conversational, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "isConversational"
+          field :cta_language, -> { String }, optional: true, nullable: false, api_name: "ctaLanguage"
+          field :demo_trigger, -> { String }, optional: true, nullable: false, api_name: "demoTrigger"
+        end
+      end
+    end
+  end
+end