rcs 2.0.13 → 2.0.15

data/lib/pinnacle/types/rcs_agent_details_agent_use_case.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Types
+    module RcsAgentDetailsAgentUseCase
+      extend Pinnacle::Internal::Types::Enum
+
+      TRANSACTIONAL = "TRANSACTIONAL"
+      PROMOTIONAL = "PROMOTIONAL"
+      OTP = "OTP"
+      MULTI_USE = "MULTI_USE"
+    end
+  end
+end

data/lib/pinnacle/types/rcs_agent_details_emails_item.rb

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

data/lib/pinnacle/types/rcs_agent_details_phones_item.rb

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

data/lib/pinnacle/types/rcs_agent_details_websites_item.rb

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

data/lib/pinnacle/types/rcs_agent_response.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Types
+    # Response containing details of an RCS agent.
+    class RcsAgentResponse < Internal::Types::Model
+      field :id, -> { String }, optional: false, nullable: false
+      field :type, -> { String }, optional: false, nullable: false
+      field :service_id, -> { String }, optional: false, nullable: false, api_name: "serviceId"
+      field :carrier_launches, -> { Pinnacle::Types::CarrierLaunches }, optional: false, nullable: false, api_name: "carrierLaunches"
+      field :details, -> { Pinnacle::Types::RcsAgentDetails }, optional: false, nullable: false
+    end
+  end
+end

data/lib/pinnacle/types/rcs_campaign.rb

@@ -7,15 +7,12 @@ module Pinnacle
       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::Types::RcsCampaignSchemaLinks }, optional: true, nullable: false
-      field :use_case, -> { Pinnacle::Types::RcsCampaignSchemaUseCase }, optional: true, nullable: false, api_name: "useCase"
-      field :opt_in_terms_and_conditions, -> { String }, optional: true, nullable: false, api_name: "optInTermsAndConditions"
+      field :use_case_description, -> { String }, optional: true, nullable: false, api_name: "useCaseDescription"
       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 :cta_media, -> { String }, optional: true, nullable: false, api_name: "ctaMedia"
+      field :opt_in_method, -> { String }, optional: true, nullable: false, api_name: "optInMethod"
       field :keywords, -> { Pinnacle::Types::RcsCampaignSchemaKeywords }, optional: true, nullable: false
       field :traffic, -> { Pinnacle::Types::RcsCampaignSchemaTraffic }, 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

data/lib/pinnacle/types/rcs_campaign_summary.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Types
+    class RcsCampaignSummary < Internal::Types::Model
+      field :campaign_id, -> { String }, optional: false, nullable: false, api_name: "campaignId"
+      field :name, -> { String }, optional: true, nullable: false
+      field :status, -> { Pinnacle::Types::RcsCampaignSummaryStatus }, optional: false, nullable: false
+      field :brand_id, -> { String }, optional: true, nullable: false, api_name: "brandId"
+      field :agent_id, -> { String }, optional: true, nullable: false, api_name: "agentId"
+      field :created_at, -> { String }, optional: false, nullable: false, api_name: "createdAt"
+      field :updated_at, -> { String }, optional: false, nullable: false, api_name: "updatedAt"
+    end
+  end
+end

data/lib/pinnacle/types/rcs_campaign_summary_status.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Types
+    module RcsCampaignSummaryStatus
+      extend Pinnacle::Internal::Types::Enum
+
+      INCOMPLETE = "INCOMPLETE"
+      IN_REVIEW = "IN REVIEW"
+      VERIFIED = "VERIFIED"
+      FAILED = "FAILED"
+    end
+  end
+end

data/lib/pinnacle/types/rcs_whitelist_status.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Types
+    module RcsWhitelistStatus
+      extend Pinnacle::Internal::Types::Enum
+
+      PENDING = "PENDING"
+      ACCEPTED = "ACCEPTED"
+      REJECTED = "REJECTED"
+    end
+  end
+end

data/lib/pinnacle/types/scheduled_message_summary.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Types
+    class ScheduledMessageSummary < Internal::Types::Model
+      field :id, -> { String }, optional: false, nullable: false
+      field :send_at, -> { String }, optional: false, nullable: true, api_name: "sendAt"
+      field :status, -> { Pinnacle::Types::ScheduledMessageSummaryStatus }, optional: false, nullable: false
+      field :recurrence, -> { String }, optional: false, nullable: true
+      field :timezone, -> { String }, optional: false, nullable: true
+      field :end_date, -> { String }, optional: false, nullable: true, api_name: "endDate"
+      field :payload, -> { Internal::Types::Hash[String, Object] }, optional: false, nullable: false
+      field :created_at, -> { String }, optional: false, nullable: false, api_name: "createdAt"
+      field :updated_at, -> { String }, optional: false, nullable: false, api_name: "updatedAt"
+    end
+  end
+end

data/lib/pinnacle/types/scheduled_message_summary_status.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Types
+    module ScheduledMessageSummaryStatus
+      extend Pinnacle::Internal::Types::Enum
+
+      ACTIVE = "ACTIVE"
+      CANCELLED = "CANCELLED"
+      FAILED = "FAILED"
+    end
+  end
+end

data/lib/pinnacle/types/send_rich_message_options.rb

@@ -5,7 +5,6 @@ module Pinnacle
     # Configure how your RCS message is sent and tracked.
     class SendRichMessageOptions < Internal::Types::Model
       field :schedule, -> { Pinnacle::Types::MessageSchedule }, optional: true, nullable: false
-      field :test_mode, -> { Internal::Types::Boolean }, optional: true, nullable: false
       field :tracking, -> { Pinnacle::Types::Tracking }, optional: true, nullable: false
       field :transcode, -> { Internal::Types::Boolean }, optional: true, nullable: false
       field :validate, -> { Internal::Types::Boolean }, optional: true, nullable: false

data/lib/pinnacle/types/sent_rich_message_fallback_mms.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Types
+    # Returned when a fallback is configured and the recipient does not support RCS. The API checks RCS capabilities at
+    # send time. If the recipient's device doesn't support RCS, the fallback MMS is sent instead. You will also receive
+    # a `FALLBACK_SENT` webhook event for the original RCS message.
+    class SentRichMessageFallbackMms < Internal::Types::Model
+      field :fallback_sent, -> { Internal::Types::Boolean }, optional: false, nullable: false, api_name: "fallbackSent"
+      field :original_message_id, -> { String }, optional: false, nullable: false, api_name: "originalMessageId"
+    end
+  end
+end

data/lib/pinnacle/types/sent_rich_message_fallback_sms.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Types
+    # Returned when a fallback is configured and the recipient does not support RCS. The API checks RCS capabilities at
+    # send time. If the recipient's device doesn't support RCS, the fallback SMS is sent instead. You will also receive
+    # a `FALLBACK_SENT` webhook event for the original RCS message.
+    class SentRichMessageFallbackSms < Internal::Types::Model
+      field :fallback_sent, -> { Internal::Types::Boolean }, optional: false, nullable: false, api_name: "fallbackSent"
+      field :original_message_id, -> { String }, optional: false, nullable: false, api_name: "originalMessageId"
+    end
+  end
+end

data/lib/pinnacle/types/test_agent_response.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Types
+    # Response returned after creating or updating a test agent.
+    class TestAgentResponse < Internal::Types::Model
+      field :id, -> { String }, optional: false, nullable: false
+      field :type, -> { String }, optional: false, nullable: false
+      field :service_id, -> { String }, optional: false, nullable: false, api_name: "serviceId"
+      field :details, -> { Pinnacle::Types::RcsAgentDetails }, optional: false, nullable: false
+    end
+  end
+end

data/lib/pinnacle/types/test_agent_whitelist_response.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Types
+    # Response containing the whitelist status of a phone number.
+    class TestAgentWhitelistResponse < Internal::Types::Model
+      field :status, -> { Pinnacle::Types::RcsWhitelistStatus }, optional: false, nullable: false
+    end
+  end
+end

data/lib/pinnacle/types/toll_free_campaign_summary.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Types
+    class TollFreeCampaignSummary < Internal::Types::Model
+      field :campaign_id, -> { String }, optional: false, nullable: false, api_name: "campaignId"
+      field :name, -> { String }, optional: true, nullable: false
+      field :status, -> { Pinnacle::Types::TollFreeCampaignSummaryStatus }, optional: false, nullable: false
+      field :brand_id, -> { String }, optional: true, nullable: false, api_name: "brandId"
+      field :use_case, -> { String }, optional: true, nullable: false, api_name: "useCase"
+      field :created_at, -> { String }, optional: false, nullable: false, api_name: "createdAt"
+      field :updated_at, -> { String }, optional: false, nullable: false, api_name: "updatedAt"
+    end
+  end
+end

data/lib/pinnacle/types/toll_free_campaign_summary_status.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Types
+    module TollFreeCampaignSummaryStatus
+      extend Pinnacle::Internal::Types::Enum
+
+      INCOMPLETE = "INCOMPLETE"
+      IN_REVIEW = "IN REVIEW"
+      VERIFIED = "VERIFIED"
+      FAILED = "FAILED"
+    end
+  end
+end

data/lib/pinnacle/types/webhook_event_enum.rb

@@ -7,6 +7,7 @@ module Pinnacle
 
       MESSAGE_STATUS = "MESSAGE.STATUS"
       MESSAGE_RECEIVED = "MESSAGE.RECEIVED"
+      USER_TYPING = "USER.TYPING"
     end
   end
 end

data/lib/pinnacle/types/webhook_summary.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Types
+    class WebhookSummary < Internal::Types::Model
+      field :id, -> { String }, optional: false, nullable: false
+      field :name, -> { String }, optional: false, nullable: false
+      field :endpoint, -> { String }, optional: false, nullable: false
+      field :status, -> { Pinnacle::Types::WebhookSummaryStatus }, optional: false, nullable: false
+      field :created_at, -> { String }, optional: false, nullable: false, api_name: "createdAt"
+      field :updated_at, -> { String }, optional: false, nullable: false, api_name: "updatedAt"
+    end
+  end
+end

data/lib/pinnacle/types/webhook_summary_status.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Types
+    module WebhookSummaryStatus
+      extend Pinnacle::Internal::Types::Enum
+
+      DISABLED = "DISABLED"
+      ENABLED = "ENABLED"
+      DELETED = "DELETED"
+    end
+  end
+end

data/lib/pinnacle/types/whitelisted_number_summary.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Types
+    class WhitelistedNumberSummary < Internal::Types::Model
+      field :number, -> { String }, optional: false, nullable: false
+      field :status, -> { Pinnacle::Types::WhitelistedNumberSummaryStatus }, optional: false, nullable: false
+      field :agent_id, -> { String }, optional: false, nullable: false, api_name: "agentId"
+      field :created_at, -> { String }, optional: false, nullable: false, api_name: "createdAt"
+    end
+  end
+end

data/lib/pinnacle/types/whitelisted_number_summary_status.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Types
+    module WhitelistedNumberSummaryStatus
+      extend Pinnacle::Internal::Types::Enum
+
+      ACCEPTED = "ACCEPTED"
+      REJECTED = "REJECTED"
+      PENDING = "PENDING"
+    end
+  end
+end

data/lib/pinnacle/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Pinnacle
-  VERSION = "2.0.13"
+  VERSION = "2.0.15"
 end

data/lib/pinnacle/webhooks/client.rb

@@ -43,6 +43,119 @@ module Pinnacle
           raise error_class.new(response.body, code: code)
         end
       end
+
+      # List all webhooks with optional filtering and pagination. Results are sorted by creation date, newest first.
+      #
+      # @param request_options [Hash]
+      # @param params [Pinnacle::Webhooks::Types::ListWebhooksParams]
+      # @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::ListWebhooksResponse]
+      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: "webhooks/list",
+          body: Pinnacle::Webhooks::Types::ListWebhooksParams.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::ListWebhooksResponse.load(response.body)
+        else
+          error_class = Pinnacle::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # Attach a webhook to one or more senders (phone numbers or RCS agent IDs) to receive real-time event
+      # notifications. <br>
+      #
+      # You can attach an existing webhook by providing its ID, or create a new webhook by specifying a name and URL.
+      # Supports bulk operations with up to 50 senders per request. <br>
+      #
+      # Subscriptions are additive — attaching new senders does not remove existing ones. Re-attaching the same sender
+      # updates the event type filter without creating duplicates.
+      #
+      # @param request_options [Hash]
+      # @param params [Pinnacle::Webhooks::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
+      #
+      # @return [Pinnacle::Types::AttachWebhookResult]
+      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: "webhooks/attach",
+          body: Pinnacle::Webhooks::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::AttachWebhookResult.load(response.body)
+        else
+          error_class = Pinnacle::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # Detach a webhook from one or more senders (phone numbers or RCS agent IDs) to stop receiving event
+      # notifications. <br>
+      #
+      # The webhook itself is not deleted and remains available for use with other senders. Works regardless of webhook
+      # status. Supports bulk operations with up to 50 senders per request.
+      #
+      # @param request_options [Hash]
+      # @param params [Pinnacle::Webhooks::Types::DetachWebhookParams]
+      # @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::DetachWebhookResult]
+      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: "POST",
+          path: "webhooks/detach",
+          body: Pinnacle::Webhooks::Types::DetachWebhookParams.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::DetachWebhookResult.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/webhooks/types/attach_webhook_params.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Webhooks
+    module Types
+      class AttachWebhookParams < Internal::Types::Model
+        field :senders, -> { Internal::Types::Array[String] }, optional: false, nullable: false
+        field :webhook_id, -> { String }, optional: true, nullable: false, api_name: "webhookId"
+        field :name, -> { String }, optional: true, nullable: false
+        field :url, -> { String }, optional: true, nullable: false
+        field :event, -> { Pinnacle::Types::WebhookEventEnum }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/pinnacle/webhooks/types/detach_webhook_params.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Webhooks
+    module Types
+      class DetachWebhookParams < Internal::Types::Model
+        field :webhook_id, -> { String }, optional: false, nullable: false, api_name: "webhookId"
+        field :senders, -> { Internal::Types::Array[String] }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/pinnacle/webhooks/types/list_webhooks_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Webhooks
+    module Types
+      class ListWebhooksParams < 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::Webhooks::Types::ListWebhooksRequestStatus }, optional: true, nullable: false
+        field :endpoint, -> { String }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/pinnacle/webhooks/types/list_webhooks_request_status.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Webhooks
+    module Types
+      module ListWebhooksRequestStatus
+        extend Pinnacle::Internal::Types::Enum
+
+        DISABLED = "DISABLED"
+        ENABLED = "ENABLED"
+        DELETED = "DELETED"
+      end
+    end
+  end
+end