rcs 1.0.18 → 2.0.0.pre.rc.2

data/lib/rcs/types/webhook_event_enum.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Types
+    # Types of events that can trigger webhook notifications for phone numbers.
+    #  Subscribe to specific events to receive real-time updates about your phone
+    #  number activity.
+    class WebhookEventEnum
+      MESSAGE_STATUS = "MESSAGE.STATUS"
+      MESSAGE_RECEIVED = "MESSAGE.RECEIVED"
+    end
+  end
+end

data/lib/rcs/types/webhook_result.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require_relative "webhooks"
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    # Response containing all webhooks that match the requested identifiers.
+    #  Only includes the essential webhook information needed for identification and
+    #  management.
+    class WebhookResult
+      # @return [Array<Pinnacle::Types::Webhooks>] List of webhooks.
+      attr_reader :webhooks
+      # @return [OpenStruct] Additional properties unmapped to the current class definition
+      attr_reader :additional_properties
+      # @return [Object]
+      attr_reader :_field_set
+      protected :_field_set
+
+      OMIT = Object.new
+
+      # @param webhooks [Array<Pinnacle::Types::Webhooks>] List of webhooks.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::WebhookResult]
+      def initialize(webhooks:, additional_properties: nil)
+        @webhooks = webhooks
+        @additional_properties = additional_properties
+        @_field_set = { "webhooks": webhooks }
+      end
+
+      # Deserialize a JSON object to an instance of WebhookResult
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::WebhookResult]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        webhooks = parsed_json["webhooks"]&.map do |item|
+          item = item.to_json
+          Pinnacle::Types::Webhooks.from_json(json_object: item)
+        end
+        new(webhooks: webhooks, additional_properties: struct)
+      end
+
+      # Serialize an instance of WebhookResult to a JSON object
+      #
+      # @return [String]
+      def to_json(*_args)
+        @_field_set&.to_json
+      end
+
+      # Leveraged for Union-type generation, validate_raw attempts to parse the given
+      #  hash and check each fields type against the current object's property
+      #  definitions.
+      #
+      # @param obj [Object]
+      # @return [Void]
+      def self.validate_raw(obj:)
+        obj.webhooks.is_a?(Array) != false || raise("Passed value for field obj.webhooks is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/rcs/{company/types/company_update_response_brand.rb → types/webhooks.rb}

@@ -4,12 +4,15 @@ require "ostruct"
 require "json"
 
 module Pinnacle
-  class Company
-    class CompanyUpdateResponseBrand
-      # @return [String]
-      attr_reader :name
-      # @return [Float]
+  module Types
+    # Webhook configuration that defines where event notifications are sent.
+    class Webhooks
+      # @return [String] URL where webhook events are delivered.
+      attr_reader :endpoint
+      # @return [Integer] Unique identifier for the webhook.
       attr_reader :id
+      # @return [String] Name of the webhook.
+      attr_reader :name
       # @return [OpenStruct] Additional properties unmapped to the current class definition
       attr_reader :additional_properties
       # @return [Object]
@@ -18,34 +21,38 @@ module Pinnacle
 
       OMIT = Object.new
 
-      # @param name [String]
-      # @param id [Float]
+      # @param endpoint [String] URL where webhook events are delivered.
+      # @param id [Integer] Unique identifier for the webhook.
+      # @param name [String] Name of the webhook.
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-      # @return [Pinnacle::Company::CompanyUpdateResponseBrand]
-      def initialize(name:, id:, additional_properties: nil)
-        @name = name
+      # @return [Pinnacle::Types::Webhooks]
+      def initialize(endpoint:, id:, name:, additional_properties: nil)
+        @endpoint = endpoint
         @id = id
+        @name = name
         @additional_properties = additional_properties
-        @_field_set = { "name": name, "id": id }
+        @_field_set = { "endpoint": endpoint, "id": id, "name": name }
       end
 
-      # Deserialize a JSON object to an instance of CompanyUpdateResponseBrand
+      # Deserialize a JSON object to an instance of Webhooks
       #
       # @param json_object [String]
-      # @return [Pinnacle::Company::CompanyUpdateResponseBrand]
+      # @return [Pinnacle::Types::Webhooks]
       def self.from_json(json_object:)
         struct = JSON.parse(json_object, object_class: OpenStruct)
         parsed_json = JSON.parse(json_object)
-        name = parsed_json["name"]
+        endpoint = parsed_json["endpoint"]
         id = parsed_json["id"]
+        name = parsed_json["name"]
         new(
-          name: name,
+          endpoint: endpoint,
           id: id,
+          name: name,
           additional_properties: struct
         )
       end
 
-      # Serialize an instance of CompanyUpdateResponseBrand to a JSON object
+      # Serialize an instance of Webhooks to a JSON object
       #
       # @return [String]
       def to_json(*_args)
@@ -59,8 +66,9 @@ module Pinnacle
       # @param obj [Object]
       # @return [Void]
       def self.validate_raw(obj:)
+        obj.endpoint.is_a?(String) != false || raise("Passed value for field obj.endpoint is not the expected type, validation failed.")
+        obj.id.is_a?(Integer) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
         obj.name.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
-        obj.id.is_a?(Float) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
       end
     end
   end

data/lib/rcs/types/zod_error.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    class ZodError
+      # @return [String] Human-readable summary of validation failures.
+      attr_reader :description
+      # @return [Hash{String => Object}] Structured dictionary of issues containing two main sections:
+      #  - `errors`: Array of global validation errors not tied to specific fields
+      #  - `properties`: Object mapping field names to their specific validation errors,
+      #  where each field contains an `errors` array
+      attr_reader :errors
+      # @return [OpenStruct] Additional properties unmapped to the current class definition
+      attr_reader :additional_properties
+      # @return [Object]
+      attr_reader :_field_set
+      protected :_field_set
+
+      OMIT = Object.new
+
+      # @param description [String] Human-readable summary of validation failures.
+      # @param errors [Hash{String => Object}] Structured dictionary of issues containing two main sections:
+      #  - `errors`: Array of global validation errors not tied to specific fields
+      #  - `properties`: Object mapping field names to their specific validation errors,
+      #  where each field contains an `errors` array
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::ZodError]
+      def initialize(description:, errors:, additional_properties: nil)
+        @description = description
+        @errors = errors
+        @additional_properties = additional_properties
+        @_field_set = { "description": description, "errors": errors }
+      end
+
+      # Deserialize a JSON object to an instance of ZodError
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::ZodError]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        description = parsed_json["description"]
+        errors = parsed_json["errors"]
+        new(
+          description: description,
+          errors: errors,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of ZodError to a JSON object
+      #
+      # @return [String]
+      def to_json(*_args)
+        @_field_set&.to_json
+      end
+
+      # Leveraged for Union-type generation, validate_raw attempts to parse the given
+      #  hash and check each fields type against the current object's property
+      #  definitions.
+      #
+      # @param obj [Object]
+      # @return [Void]
+      def self.validate_raw(obj:)
+        obj.description.is_a?(String) != false || raise("Passed value for field obj.description is not the expected type, validation failed.")
+        obj.errors.is_a?(Hash) != false || raise("Passed value for field obj.errors is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/rcs/webhooks/client.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+require_relative "../../requests"
+require_relative "../types/webhook_result"
+require "async"
+
+module Pinnacle
+  class WebhooksClient
+    # @return [Pinnacle::RequestClient]
+    attr_reader :request_client
+
+    # @param request_client [Pinnacle::RequestClient]
+    # @return [Pinnacle::WebhooksClient]
+    def initialize(request_client:)
+      @request_client = request_client
+    end
+
+    # Retrieve all webhook that are set up to receive events for specific URLs or
+    #  phone numbers.
+    #
+    # @param identifiers [Array<String>] List of URLs or phone numbers in E.164 format that the webhook is attached to.
+    # @param request_options [Pinnacle::RequestOptions]
+    # @return [Pinnacle::Types::WebhookResult]
+    # @example
+    #  api = Pinnacle::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: Pinnacle::Environment::DEFAULT,
+    #    api_key: "YOUR_API_KEY"
+    #  )
+    #  api.webhooks.get(identifiers: ["https://www.pinnacle.sh/payment", "+14155678901", "https://www.pinnacle.sh/sms-callback", "+14153456659"])
+    def get(identifiers:, request_options: nil)
+      response = @request_client.conn.post do |req|
+        req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+        req.headers["PINNACLE-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
+        req.headers = {
+      **(req.headers || {}),
+      **@request_client.get_headers,
+      **(request_options&.additional_headers || {})
+        }.compact
+        unless request_options.nil? || request_options&.additional_query_parameters.nil?
+          req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+        end
+        req.body = { **(request_options&.additional_body_parameters || {}), identifiers: identifiers }.compact
+        req.url "#{@request_client.get_url(request_options: request_options)}/webhooks"
+      end
+      Pinnacle::Types::WebhookResult.from_json(json_object: response.body)
+    end
+  end
+
+  class AsyncWebhooksClient
+    # @return [Pinnacle::AsyncRequestClient]
+    attr_reader :request_client
+
+    # @param request_client [Pinnacle::AsyncRequestClient]
+    # @return [Pinnacle::AsyncWebhooksClient]
+    def initialize(request_client:)
+      @request_client = request_client
+    end
+
+    # Retrieve all webhook that are set up to receive events for specific URLs or
+    #  phone numbers.
+    #
+    # @param identifiers [Array<String>] List of URLs or phone numbers in E.164 format that the webhook is attached to.
+    # @param request_options [Pinnacle::RequestOptions]
+    # @return [Pinnacle::Types::WebhookResult]
+    # @example
+    #  api = Pinnacle::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: Pinnacle::Environment::DEFAULT,
+    #    api_key: "YOUR_API_KEY"
+    #  )
+    #  api.webhooks.get(identifiers: ["https://www.pinnacle.sh/payment", "+14155678901", "https://www.pinnacle.sh/sms-callback", "+14153456659"])
+    def get(identifiers:, request_options: nil)
+      Async do
+        response = @request_client.conn.post do |req|
+          req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+          req.headers["PINNACLE-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
+          req.headers = {
+        **(req.headers || {}),
+        **@request_client.get_headers,
+        **(request_options&.additional_headers || {})
+          }.compact
+          unless request_options.nil? || request_options&.additional_query_parameters.nil?
+            req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+          end
+          req.body = { **(request_options&.additional_body_parameters || {}), identifiers: identifiers }.compact
+          req.url "#{@request_client.get_url(request_options: request_options)}/webhooks"
+        end
+        Pinnacle::Types::WebhookResult.from_json(json_object: response.body)
+      end
+    end
+  end
+end

data/lib/rcs.rb

@@ -3,18 +3,38 @@
 require_relative "environment"
 require_relative "types_export"
 require_relative "requests"
-require_relative "rcs/company/client"
-require_relative "rcs/send/client"
+require_relative "rcs/brands/client"
+require_relative "rcs/contacts/client"
+require_relative "rcs/conversations/client"
+require_relative "rcs/messages/client"
+require_relative "rcs/phone_numbers/client"
+require_relative "rcs/webhooks/client"
+require_relative "rcs/campaigns/client"
+require_relative "rcs/message/client"
+require_relative "rcs/status/client"
 require_relative "rcs/tools/client"
-require_relative "rcs/types/rcs_functionalities"
 
 module Pinnacle
   class Client
-    # @return [Pinnacle::CompanyClient]
-    attr_reader :company
-    # @return [Pinnacle::SendClient]
-    attr_reader :send
-    # @return [Pinnacle::ToolsClient]
+    # @return [Pinnacle::BrandsClient]
+    attr_reader :brands
+    # @return [Pinnacle::ContactsClient]
+    attr_reader :contacts
+    # @return [Pinnacle::ConversationsClient]
+    attr_reader :conversations
+    # @return [Pinnacle::MessagesClient]
+    attr_reader :messages
+    # @return [Pinnacle::PhoneNumbersClient]
+    attr_reader :phone_numbers
+    # @return [Pinnacle::WebhooksClient]
+    attr_reader :webhooks
+    # @return [Pinnacle::Campaigns::Client]
+    attr_reader :campaigns
+    # @return [Pinnacle::Message::Client]
+    attr_reader :message
+    # @return [Pinnacle::Status::Client]
+    attr_reader :status
+    # @return [Pinnacle::Tools::Client]
     attr_reader :tools
 
     # @param base_url [String]
@@ -32,50 +52,39 @@ module Pinnacle
         timeout_in_seconds: timeout_in_seconds,
         api_key: api_key
       )
-      @company = Pinnacle::CompanyClient.new(request_client: @request_client)
-      @send = Pinnacle::SendClient.new(request_client: @request_client)
-      @tools = Pinnacle::ToolsClient.new(request_client: @request_client)
-    end
-
-    # Retrieve the RCS functionality of a phone number. For example checks if a phone
-    #  number can receive RCS message and if it can receive RCS carousels.
-    #
-    # @param phone_number [String] The phone number to check for RCS functionality. Should be in E.164 format (i.e.
-    #  +12345678901).
-    # @param request_options [Pinnacle::RequestOptions]
-    # @return [Pinnacle::RcsFunctionalities]
-    # @example
-    #  api = Pinnacle::Client.new(
-    #    base_url: "https://api.example.com",
-    #    environment: Pinnacle::Environment::DEFAULT,
-    #    api_key: "YOUR_API_KEY"
-    #  )
-    #  api.get_rcs_functionality
-    def get_rcs_functionality(phone_number: nil, request_options: nil)
-      response = @request_client.conn.get do |req|
-        req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
-        req.headers["PINNACLE-API-Key"] = request_options.api_key unless request_options&.api_key.nil?
-        req.headers = {
-      **(req.headers || {}),
-      **@request_client.get_headers,
-      **(request_options&.additional_headers || {})
-        }.compact
-        req.params = { **(request_options&.additional_query_parameters || {}), "phoneNumber": phone_number }.compact
-        unless request_options.nil? || request_options&.additional_body_parameters.nil?
-          req.body = { **(request_options&.additional_body_parameters || {}) }.compact
-        end
-        req.url "#{@request_client.get_url(request_options: request_options)}/rcs_functionality"
-      end
-      Pinnacle::RcsFunctionalities.from_json(json_object: response.body)
+      @brands = Pinnacle::BrandsClient.new(request_client: @request_client)
+      @contacts = Pinnacle::ContactsClient.new(request_client: @request_client)
+      @conversations = Pinnacle::ConversationsClient.new(request_client: @request_client)
+      @messages = Pinnacle::MessagesClient.new(request_client: @request_client)
+      @phone_numbers = Pinnacle::PhoneNumbersClient.new(request_client: @request_client)
+      @webhooks = Pinnacle::WebhooksClient.new(request_client: @request_client)
+      @campaigns = Pinnacle::Campaigns::Client.new(request_client: @request_client)
+      @message = Pinnacle::Message::Client.new(request_client: @request_client)
+      @status = Pinnacle::Status::Client.new(request_client: @request_client)
+      @tools = Pinnacle::Tools::Client.new(request_client: @request_client)
     end
   end
 
   class AsyncClient
-    # @return [Pinnacle::AsyncCompanyClient]
-    attr_reader :company
-    # @return [Pinnacle::AsyncSendClient]
-    attr_reader :send
-    # @return [Pinnacle::AsyncToolsClient]
+    # @return [Pinnacle::AsyncBrandsClient]
+    attr_reader :brands
+    # @return [Pinnacle::AsyncContactsClient]
+    attr_reader :contacts
+    # @return [Pinnacle::AsyncConversationsClient]
+    attr_reader :conversations
+    # @return [Pinnacle::AsyncMessagesClient]
+    attr_reader :messages
+    # @return [Pinnacle::AsyncPhoneNumbersClient]
+    attr_reader :phone_numbers
+    # @return [Pinnacle::AsyncWebhooksClient]
+    attr_reader :webhooks
+    # @return [Pinnacle::Campaigns::AsyncClient]
+    attr_reader :campaigns
+    # @return [Pinnacle::Message::AsyncClient]
+    attr_reader :message
+    # @return [Pinnacle::Status::AsyncClient]
+    attr_reader :status
+    # @return [Pinnacle::Tools::AsyncClient]
     attr_reader :tools
 
     # @param base_url [String]
@@ -93,41 +102,16 @@ module Pinnacle
         timeout_in_seconds: timeout_in_seconds,
         api_key: api_key
       )
-      @company = Pinnacle::AsyncCompanyClient.new(request_client: @async_request_client)
-      @send = Pinnacle::AsyncSendClient.new(request_client: @async_request_client)
-      @tools = Pinnacle::AsyncToolsClient.new(request_client: @async_request_client)
-    end
-
-    # Retrieve the RCS functionality of a phone number. For example checks if a phone
-    #  number can receive RCS message and if it can receive RCS carousels.
-    #
-    # @param phone_number [String] The phone number to check for RCS functionality. Should be in E.164 format (i.e.
-    #  +12345678901).
-    # @param request_options [Pinnacle::RequestOptions]
-    # @return [Pinnacle::RcsFunctionalities]
-    # @example
-    #  api = Pinnacle::Client.new(
-    #    base_url: "https://api.example.com",
-    #    environment: Pinnacle::Environment::DEFAULT,
-    #    api_key: "YOUR_API_KEY"
-    #  )
-    #  api.get_rcs_functionality
-    def get_rcs_functionality(phone_number: nil, request_options: nil)
-      response = @async_request_client.conn.get do |req|
-        req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
-        req.headers["PINNACLE-API-Key"] = request_options.api_key unless request_options&.api_key.nil?
-        req.headers = {
-      **(req.headers || {}),
-      **@async_request_client.get_headers,
-      **(request_options&.additional_headers || {})
-        }.compact
-        req.params = { **(request_options&.additional_query_parameters || {}), "phoneNumber": phone_number }.compact
-        unless request_options.nil? || request_options&.additional_body_parameters.nil?
-          req.body = { **(request_options&.additional_body_parameters || {}) }.compact
-        end
-        req.url "#{@async_request_client.get_url(request_options: request_options)}/rcs_functionality"
-      end
-      Pinnacle::RcsFunctionalities.from_json(json_object: response.body)
+      @brands = Pinnacle::AsyncBrandsClient.new(request_client: @async_request_client)
+      @contacts = Pinnacle::AsyncContactsClient.new(request_client: @async_request_client)
+      @conversations = Pinnacle::AsyncConversationsClient.new(request_client: @async_request_client)
+      @messages = Pinnacle::AsyncMessagesClient.new(request_client: @async_request_client)
+      @phone_numbers = Pinnacle::AsyncPhoneNumbersClient.new(request_client: @async_request_client)
+      @webhooks = Pinnacle::AsyncWebhooksClient.new(request_client: @async_request_client)
+      @campaigns = Pinnacle::Campaigns::AsyncClient.new(request_client: @async_request_client)
+      @message = Pinnacle::Message::AsyncClient.new(request_client: @async_request_client)
+      @status = Pinnacle::Status::AsyncClient.new(request_client: @async_request_client)
+      @tools = Pinnacle::Tools::AsyncClient.new(request_client: @async_request_client)
     end
   end
 end

data/lib/requests.rb

@@ -43,8 +43,8 @@ module Pinnacle
 
     # @return [Hash{String => String}]
     def get_headers
-      headers = { "X-Fern-Language": "Ruby", "X-Fern-SDK-Name": "rcs", "X-Fern-SDK-Version": "1.0.18" }
-      headers["PINNACLE-API-Key"] = ((@api_key.is_a? Method) ? @api_key.call : @api_key) unless @api_key.nil?
+      headers = { "X-Fern-Language": "Ruby", "X-Fern-SDK-Name": "rcs", "X-Fern-SDK-Version": "2.0.0-rc.2" }
+      headers["PINNACLE-API-KEY"] = ((@api_key.is_a? Method) ? @api_key.call : @api_key) unless @api_key.nil?
       headers
     end
   end
@@ -87,8 +87,8 @@ module Pinnacle
 
     # @return [Hash{String => String}]
     def get_headers
-      headers = { "X-Fern-Language": "Ruby", "X-Fern-SDK-Name": "rcs", "X-Fern-SDK-Version": "1.0.18" }
-      headers["PINNACLE-API-Key"] = ((@api_key.is_a? Method) ? @api_key.call : @api_key) unless @api_key.nil?
+      headers = { "X-Fern-Language": "Ruby", "X-Fern-SDK-Name": "rcs", "X-Fern-SDK-Version": "2.0.0-rc.2" }
+      headers["PINNACLE-API-KEY"] = ((@api_key.is_a? Method) ? @api_key.call : @api_key) unless @api_key.nil?
       headers
     end
   end