rcs 1.0.15 → 1.0.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd6b24540486cc673f369e84cd9c3a56d58837b4143a11f79b0b8ad8d7056ee4
-  data.tar.gz: 708a541bf38d32fde5b6ef6d6338d9e3494f681f60d5811dbbc384e0bb58cf02
+  metadata.gz: 4f88305d84f5dfa29571c3467c8a95a150d51c629a7e6415a4eeeabcf9540141
+  data.tar.gz: 4b71e04b5d4d3971d3efe9d20d4154034bc7f4ff6d835aa46944198609fd1a77
 SHA512:
-  metadata.gz: b4fc78e103e1274d2ceac57826ce3bd7772901e5222fe486d2e133e3b2bd3570e26506db5438e699986b0a1bbdd9c0ae843e1e5fb8eef5f997e8df22886a2b8f
-  data.tar.gz: cf3dfa9bc7e5ad188baefef9983d6f1ac5230eafa3d08c9a9006581feb5f774bfd6213acdf0191f80f7985385fab06e2dccd6f8b00c684f637079052d2bd57c1
+  metadata.gz: d2d0b8bfb3e1a1dd1a410c3348704fac00487ec00dd08d214ffbda3f2b30bb0b3b7cfa0edc09cd75c9ecaf5503cb4320d037009b4d9825cdd019dcb03b1e1bb4
+  data.tar.gz: d4b30f94e9bdeaa2693ebca2abc8cf599bce2de7400b4c71a4a3a6376f6748192aea5cd080e971ce6982709d82938fc7553c21e29eaf9f128120e7e16eaab721

data/lib/rcs/company/client.rb

@@ -3,12 +3,12 @@
 require_relative "../../requests"
 require_relative "../types/company"
 require "json"
-require_relative "../types/company_details"
+require_relative "types/company_register_request"
+require_relative "types/company_register_response"
 require_relative "../types/company_contact"
 require_relative "../types/messaging"
 require_relative "../types/point_of_contact"
 require_relative "../types/optionals"
-require_relative "types/company_register_response"
 require_relative "types/company_update_response"
 require "async"
 
@@ -65,39 +65,7 @@ module Pinnacle
 
     # Register a company for RCS with the Pinnacle platform
     #
-    # @param company [Hash] Request of type Pinnacle::CompanyDetails, as a Hash
-    #   * :name (String)
-    #   * :category (Pinnacle::CompanyCategory)
-    #   * :address (String)
-    #   * :ein (String)
-    #   * :description (String)
-    #   * :brand_color (String)
-    #   * :logo_url (String)
-    #   * :hero_url (String)
-    # @param company_contact [Hash] Request of type Pinnacle::CompanyContact, as a Hash
-    #   * :primary_website_url (String)
-    #   * :primary_website_label (String)
-    #   * :primary_phone (String)
-    #   * :primary_phone_label (String)
-    #   * :primary_email (String)
-    #   * :primary_email_label (String)
-    #   * :privacy_policy_url (String)
-    #   * :tos_url (String)
-    # @param messaging [Hash] Request of type Pinnacle::Messaging, as a Hash
-    #   * :opt_in (String)
-    #   * :opt_out (String)
-    #   * :opt_out_keywords (Array<String>)
-    #   * :agent_use_case (String)
-    #   * :expected_agent_responses (String)
-    # @param point_of_contact [Hash] Request of type Pinnacle::PointOfContact, as a Hash
-    #   * :poc_name (String)
-    #   * :poc_title (String)
-    #   * :poc_email (String)
-    # @param optionals [Hash] Request of type Pinnacle::Optionals, as a Hash
-    #   * :additional_websites (Array<Pinnacle::AdditionalWebsite>)
-    #   * :additional_phone_numbers (Array<Pinnacle::AdditionalPhoneNumber>)
-    #   * :additional_emails (Array<Pinnacle::AdditionalEmail>)
-    #   * :test_numbers (Array<String>)
+    # @param request [Pinnacle::Company::CompanyRegisterRequestCompanyId, Pinnacle::Company::CompanyRegisterRequestCompany]
     # @param request_options [Pinnacle::RequestOptions]
     # @return [Pinnacle::Company::CompanyRegisterResponse]
     # @example
@@ -106,18 +74,8 @@ module Pinnacle
     #    environment: Pinnacle::Environment::DEFAULT,
     #    api_key: "YOUR_API_KEY"
     #  )
-    #  api.company.register(
-    #    company: { name: "name", category: ENTERTAINMENT, address: "address", ein: "ein", description: "description", brand_color: "brandColor", logo_url: "logoUrl", hero_url: "heroUrl" },
-    #    company_contact: { primary_website_url: "primaryWebsiteUrl", primary_website_label: "primaryWebsiteLabel", primary_phone: "primaryPhone", primary_phone_label: "primaryPhoneLabel", primary_email: "primaryEmail", primary_email_label: "primaryEmailLabel", privacy_policy_url: "privacyPolicyUrl", tos_url: "tosUrl" },
-    #    messaging: { opt_in: "By opting in, you agree to receive messages from Pinnacle, including updates and promotions. Reply “STOP” to unsubscribe. Standard message and data rates may apply.", opt_out: "Reply with keywords like STOP or UNSUBSCRIBE to opt-out. A confirmation message will be sent, and no further messages will be received unless you re-subscribe.", opt_out_keywords: ["STOP", "UNSUBSCRIBE"], agent_use_case: "Pinnacle’s agent assists with product updates, promotions, order tracking, and support. It answers FAQs, provides order updates, and helps with opt-in/out processes. Escalates to live support when needed.", expected_agent_responses: "General Inquiry: “How can I assist you today?”
-    #  Order Status: “Provide your order number.”
-    #  Opt-In: “You’re now subscribed!”
-    #  Opt-Out: “You have unsubscribed.”
-    #  Escalation: “Connecting to a live agent.”
-    #  " },
-    #    point_of_contact: { poc_name: "pocName", poc_title: "pocTitle", poc_email: "pocEmail" }
-    #  )
-    def register(company:, company_contact:, messaging:, point_of_contact:, optionals: nil, request_options: nil)
+    #  api.company.register(request: { company_id: "companyId" })
+    def register(request:, 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?
@@ -129,14 +87,7 @@ module Pinnacle
         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 || {}),
-          company: company,
-          companyContact: company_contact,
-          messaging: messaging,
-          pointOfContact: point_of_contact,
-          optionals: optionals
-        }.compact
+        req.body = { **(request || {}), **(request_options&.additional_body_parameters || {}) }.compact
         req.url "#{@request_client.get_url(request_options: request_options)}/company/register"
       end
       Pinnacle::Company::CompanyRegisterResponse.from_json(json_object: response.body)
@@ -144,7 +95,8 @@ module Pinnacle
 
     # Update a company on the Pinnacle platform
     #
-    # @param company_id [String]
+    # @param company_id [String] Optional company ID. If provided, updates existing company. If not provided,
+    #  creates a new company.
     # @param company [Hash] Request of type Pinnacle::Company, as a Hash
     #   * :id (Integer)
     #   * :created_at (DateTime)
@@ -209,9 +161,9 @@ module Pinnacle
     #    environment: Pinnacle::Environment::DEFAULT,
     #    api_key: "YOUR_API_KEY"
     #  )
-    #  api.company.update(company_id: "companyId")
-    def update(company_id:, company: nil, company_contact: nil, messaging: nil, point_of_contact: nil, optionals: nil,
-               request_options: nil)
+    #  api.company.update
+    def update(company_id: nil, company: nil, company_contact: nil, messaging: nil, point_of_contact: nil,
+               optionals: nil, 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?
@@ -292,39 +244,7 @@ module Pinnacle
 
     # Register a company for RCS with the Pinnacle platform
     #
-    # @param company [Hash] Request of type Pinnacle::CompanyDetails, as a Hash
-    #   * :name (String)
-    #   * :category (Pinnacle::CompanyCategory)
-    #   * :address (String)
-    #   * :ein (String)
-    #   * :description (String)
-    #   * :brand_color (String)
-    #   * :logo_url (String)
-    #   * :hero_url (String)
-    # @param company_contact [Hash] Request of type Pinnacle::CompanyContact, as a Hash
-    #   * :primary_website_url (String)
-    #   * :primary_website_label (String)
-    #   * :primary_phone (String)
-    #   * :primary_phone_label (String)
-    #   * :primary_email (String)
-    #   * :primary_email_label (String)
-    #   * :privacy_policy_url (String)
-    #   * :tos_url (String)
-    # @param messaging [Hash] Request of type Pinnacle::Messaging, as a Hash
-    #   * :opt_in (String)
-    #   * :opt_out (String)
-    #   * :opt_out_keywords (Array<String>)
-    #   * :agent_use_case (String)
-    #   * :expected_agent_responses (String)
-    # @param point_of_contact [Hash] Request of type Pinnacle::PointOfContact, as a Hash
-    #   * :poc_name (String)
-    #   * :poc_title (String)
-    #   * :poc_email (String)
-    # @param optionals [Hash] Request of type Pinnacle::Optionals, as a Hash
-    #   * :additional_websites (Array<Pinnacle::AdditionalWebsite>)
-    #   * :additional_phone_numbers (Array<Pinnacle::AdditionalPhoneNumber>)
-    #   * :additional_emails (Array<Pinnacle::AdditionalEmail>)
-    #   * :test_numbers (Array<String>)
+    # @param request [Pinnacle::Company::CompanyRegisterRequestCompanyId, Pinnacle::Company::CompanyRegisterRequestCompany]
     # @param request_options [Pinnacle::RequestOptions]
     # @return [Pinnacle::Company::CompanyRegisterResponse]
     # @example
@@ -333,18 +253,8 @@ module Pinnacle
     #    environment: Pinnacle::Environment::DEFAULT,
     #    api_key: "YOUR_API_KEY"
     #  )
-    #  api.company.register(
-    #    company: { name: "name", category: ENTERTAINMENT, address: "address", ein: "ein", description: "description", brand_color: "brandColor", logo_url: "logoUrl", hero_url: "heroUrl" },
-    #    company_contact: { primary_website_url: "primaryWebsiteUrl", primary_website_label: "primaryWebsiteLabel", primary_phone: "primaryPhone", primary_phone_label: "primaryPhoneLabel", primary_email: "primaryEmail", primary_email_label: "primaryEmailLabel", privacy_policy_url: "privacyPolicyUrl", tos_url: "tosUrl" },
-    #    messaging: { opt_in: "By opting in, you agree to receive messages from Pinnacle, including updates and promotions. Reply “STOP” to unsubscribe. Standard message and data rates may apply.", opt_out: "Reply with keywords like STOP or UNSUBSCRIBE to opt-out. A confirmation message will be sent, and no further messages will be received unless you re-subscribe.", opt_out_keywords: ["STOP", "UNSUBSCRIBE"], agent_use_case: "Pinnacle’s agent assists with product updates, promotions, order tracking, and support. It answers FAQs, provides order updates, and helps with opt-in/out processes. Escalates to live support when needed.", expected_agent_responses: "General Inquiry: “How can I assist you today?”
-    #  Order Status: “Provide your order number.”
-    #  Opt-In: “You’re now subscribed!”
-    #  Opt-Out: “You have unsubscribed.”
-    #  Escalation: “Connecting to a live agent.”
-    #  " },
-    #    point_of_contact: { poc_name: "pocName", poc_title: "pocTitle", poc_email: "pocEmail" }
-    #  )
-    def register(company:, company_contact:, messaging:, point_of_contact:, optionals: nil, request_options: nil)
+    #  api.company.register(request: { company_id: "companyId" })
+    def register(request:, 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?
@@ -357,14 +267,7 @@ module Pinnacle
           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 || {}),
-            company: company,
-            companyContact: company_contact,
-            messaging: messaging,
-            pointOfContact: point_of_contact,
-            optionals: optionals
-          }.compact
+          req.body = { **(request || {}), **(request_options&.additional_body_parameters || {}) }.compact
           req.url "#{@request_client.get_url(request_options: request_options)}/company/register"
         end
         Pinnacle::Company::CompanyRegisterResponse.from_json(json_object: response.body)
@@ -373,7 +276,8 @@ module Pinnacle
 
     # Update a company on the Pinnacle platform
     #
-    # @param company_id [String]
+    # @param company_id [String] Optional company ID. If provided, updates existing company. If not provided,
+    #  creates a new company.
     # @param company [Hash] Request of type Pinnacle::Company, as a Hash
     #   * :id (Integer)
     #   * :created_at (DateTime)
@@ -438,9 +342,9 @@ module Pinnacle
     #    environment: Pinnacle::Environment::DEFAULT,
     #    api_key: "YOUR_API_KEY"
     #  )
-    #  api.company.update(company_id: "companyId")
-    def update(company_id:, company: nil, company_contact: nil, messaging: nil, point_of_contact: nil, optionals: nil,
-               request_options: nil)
+    #  api.company.update
+    def update(company_id: nil, company: nil, company_contact: nil, messaging: nil, point_of_contact: nil,
+               optionals: nil, 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?

data/lib/rcs/company/types/company_register_request.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require "json"
+require_relative "company_register_request_company_id"
+require_relative "company_register_request_company"
+
+module Pinnacle
+  class Company
+    class CompanyRegisterRequest
+      # Deserialize a JSON object to an instance of CompanyRegisterRequest
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Company::CompanyRegisterRequest]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        begin
+          Pinnacle::Company::CompanyRegisterRequestCompanyId.validate_raw(obj: struct)
+          return Pinnacle::Company::CompanyRegisterRequestCompanyId.from_json(json_object: struct) unless struct.nil?
+
+          return nil
+        rescue StandardError
+          # noop
+        end
+        begin
+          Pinnacle::Company::CompanyRegisterRequestCompany.validate_raw(obj: struct)
+          return Pinnacle::Company::CompanyRegisterRequestCompany.from_json(json_object: struct) unless struct.nil?
+
+          return nil
+        rescue StandardError
+          # noop
+        end
+        struct
+      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:)
+        begin
+          return Pinnacle::Company::CompanyRegisterRequestCompanyId.validate_raw(obj: obj)
+        rescue StandardError
+          # noop
+        end
+        begin
+          return Pinnacle::Company::CompanyRegisterRequestCompany.validate_raw(obj: obj)
+        rescue StandardError
+          # noop
+        end
+        raise("Passed value matched no type within the union, validation failed.")
+      end
+    end
+  end
+end

data/lib/rcs/company/types/company_register_request_company.rb

@@ -0,0 +1,128 @@
+# frozen_string_literal: true
+
+require_relative "../../types/company_details"
+require_relative "../../types/company_contact"
+require_relative "../../types/messaging"
+require_relative "../../types/point_of_contact"
+require_relative "../../types/optionals"
+require "ostruct"
+require "json"
+
+module Pinnacle
+  class Company
+    # Register a new company
+    class CompanyRegisterRequestCompany
+      # @return [Pinnacle::CompanyDetails]
+      attr_reader :company
+      # @return [Pinnacle::CompanyContact]
+      attr_reader :company_contact
+      # @return [Pinnacle::Messaging]
+      attr_reader :messaging
+      # @return [Pinnacle::PointOfContact]
+      attr_reader :point_of_contact
+      # @return [Pinnacle::Optionals]
+      attr_reader :optionals
+      # @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 company [Pinnacle::CompanyDetails]
+      # @param company_contact [Pinnacle::CompanyContact]
+      # @param messaging [Pinnacle::Messaging]
+      # @param point_of_contact [Pinnacle::PointOfContact]
+      # @param optionals [Pinnacle::Optionals]
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Company::CompanyRegisterRequestCompany]
+      def initialize(company:, company_contact:, messaging:, point_of_contact:, optionals: OMIT,
+                     additional_properties: nil)
+        @company = company
+        @company_contact = company_contact
+        @messaging = messaging
+        @point_of_contact = point_of_contact
+        @optionals = optionals if optionals != OMIT
+        @additional_properties = additional_properties
+        @_field_set = {
+          "company": company,
+          "companyContact": company_contact,
+          "messaging": messaging,
+          "pointOfContact": point_of_contact,
+          "optionals": optionals
+        }.reject do |_k, v|
+          v == OMIT
+        end
+      end
+
+      # Deserialize a JSON object to an instance of CompanyRegisterRequestCompany
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Company::CompanyRegisterRequestCompany]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        if parsed_json["company"].nil?
+          company = nil
+        else
+          company = parsed_json["company"].to_json
+          company = Pinnacle::CompanyDetails.from_json(json_object: company)
+        end
+        if parsed_json["companyContact"].nil?
+          company_contact = nil
+        else
+          company_contact = parsed_json["companyContact"].to_json
+          company_contact = Pinnacle::CompanyContact.from_json(json_object: company_contact)
+        end
+        if parsed_json["messaging"].nil?
+          messaging = nil
+        else
+          messaging = parsed_json["messaging"].to_json
+          messaging = Pinnacle::Messaging.from_json(json_object: messaging)
+        end
+        if parsed_json["pointOfContact"].nil?
+          point_of_contact = nil
+        else
+          point_of_contact = parsed_json["pointOfContact"].to_json
+          point_of_contact = Pinnacle::PointOfContact.from_json(json_object: point_of_contact)
+        end
+        if parsed_json["optionals"].nil?
+          optionals = nil
+        else
+          optionals = parsed_json["optionals"].to_json
+          optionals = Pinnacle::Optionals.from_json(json_object: optionals)
+        end
+        new(
+          company: company,
+          company_contact: company_contact,
+          messaging: messaging,
+          point_of_contact: point_of_contact,
+          optionals: optionals,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of CompanyRegisterRequestCompany 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:)
+        Pinnacle::CompanyDetails.validate_raw(obj: obj.company)
+        Pinnacle::CompanyContact.validate_raw(obj: obj.company_contact)
+        Pinnacle::Messaging.validate_raw(obj: obj.messaging)
+        Pinnacle::PointOfContact.validate_raw(obj: obj.point_of_contact)
+        obj.optionals.nil? || Pinnacle::Optionals.validate_raw(obj: obj.optionals)
+      end
+    end
+  end
+end

data/lib/rcs/company/types/company_register_request_company_id.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Pinnacle
+  class Company
+    # Register an existing company
+    class CompanyRegisterRequestCompanyId
+      # @return [String] ID of an existing company to register
+      attr_reader :company_id
+      # @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 company_id [String] ID of an existing company to register
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Company::CompanyRegisterRequestCompanyId]
+      def initialize(company_id:, additional_properties: nil)
+        @company_id = company_id
+        @additional_properties = additional_properties
+        @_field_set = { "companyId": company_id }
+      end
+
+      # Deserialize a JSON object to an instance of CompanyRegisterRequestCompanyId
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Company::CompanyRegisterRequestCompanyId]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        company_id = parsed_json["companyId"]
+        new(company_id: company_id, additional_properties: struct)
+      end
+
+      # Serialize an instance of CompanyRegisterRequestCompanyId 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.company_id.is_a?(String) != false || raise("Passed value for field obj.company_id is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/rcs/tools/client.rb

@@ -0,0 +1,211 @@
+# frozen_string_literal: true
+
+require_relative "../../requests"
+require "date"
+require_relative "types/tools_shorten_url_response"
+require_relative "types/tools_upload_url_response"
+require "async"
+
+module Pinnacle
+  class ToolsClient
+    # @return [Pinnacle::RequestClient]
+    attr_reader :request_client
+
+    # @param request_client [Pinnacle::RequestClient]
+    # @return [Pinnacle::ToolsClient]
+    def initialize(request_client:)
+      @request_client = request_client
+    end
+
+    # Create a shortened URL with an optional expiration date (default and max
+    #  expiration is 90 days). The shortened URL will redirect to the original URL and
+    #  will have the following format https://urls.p1n.io/ABCD5678.
+    #
+    # @param url [String] The URL to be shortened. Must be a valid URL with either http or https protocol.
+    # @param expires_at [DateTime] Optional expiration date for the shortened URL in ISO 8601 format. Default and
+    #  max expiration is 90 days.
+    # @param request_options [Pinnacle::RequestOptions]
+    # @return [Pinnacle::Tools::ToolsShortenUrlResponse]
+    # @example
+    #  api = Pinnacle::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: Pinnacle::Environment::DEFAULT,
+    #    api_key: "YOUR_API_KEY"
+    #  )
+    #  api.tools.shorten_url(url: "https://example.com")
+    def shorten_url(url:, expires_at: nil, 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 || {}), url: url, expiresAt: expires_at }.compact
+        req.url "#{@request_client.get_url(request_options: request_options)}/tools/urls/shorten"
+      end
+      Pinnacle::Tools::ToolsShortenUrlResponse.from_json(json_object: response.body)
+    end
+
+    # Generate signed upload (expires in 2 hours) and download URLs for a file
+    #  (expires in 1 hour).
+    #  See the [Upload](/api-reference/upload) page for native Python and Typescript
+    #  SDKs.
+    #
+    # @param content_type [String] The MIME type of the file.
+    #  Supported types are audio/basic, audio/L24, audio/mp4, audio/mpeg, audio/mpg,
+    #  audio/mp3, audio/ogg, audio/aac, audio/vndrn-realaudio, audio/vndwave,
+    #  audio/3gpp, audio/3gpp2, audio/ac3, audio/webm, audio/amrnb, audio/amr,
+    #  video/mpeg, video/mp4, video/quicktime, video/webm, video/3gpp, video/3gpp2,
+    #  video/3gpptt, video/H261, video/H263, video/H2631998, video/H2632000,
+    #  video/H264, video/m4v, video/mpeg4, video/webm, image/jpeg, image/gif,
+    #  image/png, image/gif, image/bmp, image/tiff, image/webp, text/vcard,
+    #  text/xvcard, text/csv, text/rtf, text/richtext, text/calendar, text/directory,
+    #  application/ogg, application/pdf, application/vcard,
+    #  application/vndapple.pkpass.
+    # @param size [Integer] The size of the file in bytes. Should be less than 100 MB.
+    # @param name [String] The name of the file.
+    # @param request_options [Pinnacle::RequestOptions]
+    # @return [Pinnacle::Tools::ToolsUploadUrlResponse]
+    # @example
+    #  api = Pinnacle::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: Pinnacle::Environment::DEFAULT,
+    #    api_key: "YOUR_API_KEY"
+    #  )
+    #  api.tools.upload_url(
+    #    content_type: "image/png",
+    #    size: 1024,
+    #    name: "example.png"
+    #  )
+    def upload_url(content_type:, size:, name:, 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 || {}),
+          contentType: content_type,
+          size: size,
+          name: name
+        }.compact
+        req.url "#{@request_client.get_url(request_options: request_options)}/tools/uploadUrl"
+      end
+      Pinnacle::Tools::ToolsUploadUrlResponse.from_json(json_object: response.body)
+    end
+  end
+
+  class AsyncToolsClient
+    # @return [Pinnacle::AsyncRequestClient]
+    attr_reader :request_client
+
+    # @param request_client [Pinnacle::AsyncRequestClient]
+    # @return [Pinnacle::AsyncToolsClient]
+    def initialize(request_client:)
+      @request_client = request_client
+    end
+
+    # Create a shortened URL with an optional expiration date (default and max
+    #  expiration is 90 days). The shortened URL will redirect to the original URL and
+    #  will have the following format https://urls.p1n.io/ABCD5678.
+    #
+    # @param url [String] The URL to be shortened. Must be a valid URL with either http or https protocol.
+    # @param expires_at [DateTime] Optional expiration date for the shortened URL in ISO 8601 format. Default and
+    #  max expiration is 90 days.
+    # @param request_options [Pinnacle::RequestOptions]
+    # @return [Pinnacle::Tools::ToolsShortenUrlResponse]
+    # @example
+    #  api = Pinnacle::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: Pinnacle::Environment::DEFAULT,
+    #    api_key: "YOUR_API_KEY"
+    #  )
+    #  api.tools.shorten_url(url: "https://example.com")
+    def shorten_url(url:, expires_at: nil, 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 || {}), url: url, expiresAt: expires_at }.compact
+          req.url "#{@request_client.get_url(request_options: request_options)}/tools/urls/shorten"
+        end
+        Pinnacle::Tools::ToolsShortenUrlResponse.from_json(json_object: response.body)
+      end
+    end
+
+    # Generate signed upload (expires in 2 hours) and download URLs for a file
+    #  (expires in 1 hour).
+    #  See the [Upload](/api-reference/upload) page for native Python and Typescript
+    #  SDKs.
+    #
+    # @param content_type [String] The MIME type of the file.
+    #  Supported types are audio/basic, audio/L24, audio/mp4, audio/mpeg, audio/mpg,
+    #  audio/mp3, audio/ogg, audio/aac, audio/vndrn-realaudio, audio/vndwave,
+    #  audio/3gpp, audio/3gpp2, audio/ac3, audio/webm, audio/amrnb, audio/amr,
+    #  video/mpeg, video/mp4, video/quicktime, video/webm, video/3gpp, video/3gpp2,
+    #  video/3gpptt, video/H261, video/H263, video/H2631998, video/H2632000,
+    #  video/H264, video/m4v, video/mpeg4, video/webm, image/jpeg, image/gif,
+    #  image/png, image/gif, image/bmp, image/tiff, image/webp, text/vcard,
+    #  text/xvcard, text/csv, text/rtf, text/richtext, text/calendar, text/directory,
+    #  application/ogg, application/pdf, application/vcard,
+    #  application/vndapple.pkpass.
+    # @param size [Integer] The size of the file in bytes. Should be less than 100 MB.
+    # @param name [String] The name of the file.
+    # @param request_options [Pinnacle::RequestOptions]
+    # @return [Pinnacle::Tools::ToolsUploadUrlResponse]
+    # @example
+    #  api = Pinnacle::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: Pinnacle::Environment::DEFAULT,
+    #    api_key: "YOUR_API_KEY"
+    #  )
+    #  api.tools.upload_url(
+    #    content_type: "image/png",
+    #    size: 1024,
+    #    name: "example.png"
+    #  )
+    def upload_url(content_type:, size:, name:, 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 || {}),
+            contentType: content_type,
+            size: size,
+            name: name
+          }.compact
+          req.url "#{@request_client.get_url(request_options: request_options)}/tools/uploadUrl"
+        end
+        Pinnacle::Tools::ToolsUploadUrlResponse.from_json(json_object: response.body)
+      end
+    end
+  end
+end

data/lib/rcs/tools/types/tools_shorten_url_response.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require "date"
+require "ostruct"
+require "json"
+
+module Pinnacle
+  class Tools
+    class ToolsShortenUrlResponse
+      # @return [String] The shortened URL.
+      attr_reader :shortened_url
+      # @return [DateTime] The expiration date of the shortened URL, if provided.
+      attr_reader :expires_at
+      # @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 shortened_url [String] The shortened URL.
+      # @param expires_at [DateTime] The expiration date of the shortened URL, if provided.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Tools::ToolsShortenUrlResponse]
+      def initialize(shortened_url: OMIT, expires_at: OMIT, additional_properties: nil)
+        @shortened_url = shortened_url if shortened_url != OMIT
+        @expires_at = expires_at if expires_at != OMIT
+        @additional_properties = additional_properties
+        @_field_set = { "shortenedUrl": shortened_url, "expiresAt": expires_at }.reject do |_k, v|
+          v == OMIT
+        end
+      end
+
+      # Deserialize a JSON object to an instance of ToolsShortenUrlResponse
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Tools::ToolsShortenUrlResponse]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        shortened_url = parsed_json["shortenedUrl"]
+        expires_at = (DateTime.parse(parsed_json["expiresAt"]) unless parsed_json["expiresAt"].nil?)
+        new(
+          shortened_url: shortened_url,
+          expires_at: expires_at,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of ToolsShortenUrlResponse 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.shortened_url&.is_a?(String) != false || raise("Passed value for field obj.shortened_url is not the expected type, validation failed.")
+        obj.expires_at&.is_a?(DateTime) != false || raise("Passed value for field obj.expires_at is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/rcs/tools/types/tools_upload_url_response.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Pinnacle
+  class Tools
+    class ToolsUploadUrlResponse
+      # @return [String] The URL to upload the file.
+      attr_reader :upload
+      # @return [String] The URL to download the file.
+      attr_reader :download
+      # @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 upload [String] The URL to upload the file.
+      # @param download [String] The URL to download the file.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Tools::ToolsUploadUrlResponse]
+      def initialize(upload: OMIT, download: OMIT, additional_properties: nil)
+        @upload = upload if upload != OMIT
+        @download = download if download != OMIT
+        @additional_properties = additional_properties
+        @_field_set = { "upload": upload, "download": download }.reject do |_k, v|
+          v == OMIT
+        end
+      end
+
+      # Deserialize a JSON object to an instance of ToolsUploadUrlResponse
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Tools::ToolsUploadUrlResponse]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        upload = parsed_json["upload"]
+        download = parsed_json["download"]
+        new(
+          upload: upload,
+          download: download,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of ToolsUploadUrlResponse 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.upload&.is_a?(String) != false || raise("Passed value for field obj.upload is not the expected type, validation failed.")
+        obj.download&.is_a?(String) != false || raise("Passed value for field obj.download is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/rcs.rb

@@ -5,6 +5,7 @@ require_relative "types_export"
 require_relative "requests"
 require_relative "rcs/company/client"
 require_relative "rcs/send/client"
+require_relative "rcs/tools/client"
 require_relative "rcs/types/rcs_functionalities"
 
 module Pinnacle
@@ -13,6 +14,8 @@ module Pinnacle
     attr_reader :company
     # @return [Pinnacle::SendClient]
     attr_reader :send
+    # @return [Pinnacle::ToolsClient]
+    attr_reader :tools
 
     # @param base_url [String]
     # @param environment [Pinnacle::Environment]
@@ -31,6 +34,7 @@ module Pinnacle
       )
       @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
@@ -71,6 +75,8 @@ module Pinnacle
     attr_reader :company
     # @return [Pinnacle::AsyncSendClient]
     attr_reader :send
+    # @return [Pinnacle::AsyncToolsClient]
+    attr_reader :tools
 
     # @param base_url [String]
     # @param environment [Pinnacle::Environment]
@@ -89,6 +95,7 @@ module Pinnacle
       )
       @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

data/lib/requests.rb

@@ -43,7 +43,7 @@ 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.15" }
+      headers = { "X-Fern-Language": "Ruby", "X-Fern-SDK-Name": "rcs", "X-Fern-SDK-Version": "1.0.17" }
       headers["PINNACLE-API-Key"] = ((@api_key.is_a? Method) ? @api_key.call : @api_key) unless @api_key.nil?
       headers
     end
@@ -87,7 +87,7 @@ 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.15" }
+      headers = { "X-Fern-Language": "Ruby", "X-Fern-SDK-Name": "rcs", "X-Fern-SDK-Version": "1.0.17" }
       headers["PINNACLE-API-Key"] = ((@api_key.is_a? Method) ? @api_key.call : @api_key) unless @api_key.nil?
       headers
     end

data/lib/types_export.rb

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+require_relative "rcs/company/types/company_register_request_company_id"
+require_relative "rcs/company/types/company_register_request_company"
+require_relative "rcs/company/types/company_register_request"
 require_relative "rcs/company/types/company_register_response_brand"
 require_relative "rcs/company/types/company_register_response"
 require_relative "rcs/company/types/company_update_response_brand"
@@ -8,6 +11,8 @@ require_relative "rcs/send/types/rcs_fallback"
 require_relative "rcs/send/types/send_rcs_response"
 require_relative "rcs/send/types/send_sms_response"
 require_relative "rcs/send/types/send_mms_response"
+require_relative "rcs/tools/types/tools_shorten_url_response"
+require_relative "rcs/tools/types/tools_upload_url_response"
 require_relative "rcs/types/bad_request_error_body"
 require_relative "rcs/types/unauthorized_error_body"
 require_relative "rcs/types/internal_server_error_body"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rcs
 version: !ruby/object:Gem::Version
-  version: 1.0.15
+  version: 1.0.17
 platform: ruby
 authors:
 - ''
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-11-29 00:00:00.000000000 Z
+date: 2025-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async-http-faraday
@@ -100,6 +100,9 @@ files:
 - lib/gemconfig.rb
 - lib/rcs.rb
 - lib/rcs/company/client.rb
+- lib/rcs/company/types/company_register_request.rb
+- lib/rcs/company/types/company_register_request_company.rb
+- lib/rcs/company/types/company_register_request_company_id.rb
 - lib/rcs/company/types/company_register_response.rb
 - lib/rcs/company/types/company_register_response_brand.rb
 - lib/rcs/company/types/company_update_response.rb
@@ -109,6 +112,9 @@ files:
 - lib/rcs/send/types/send_mms_response.rb
 - lib/rcs/send/types/send_rcs_response.rb
 - lib/rcs/send/types/send_sms_response.rb
+- lib/rcs/tools/client.rb
+- lib/rcs/tools/types/tools_shorten_url_response.rb
+- lib/rcs/tools/types/tools_upload_url_response.rb
 - lib/rcs/types/action.rb
 - lib/rcs/types/action_lat_long.rb
 - lib/rcs/types/action_type.rb
@@ -151,7 +157,7 @@ metadata:
   homepage_uri: https://github.com/pinnacle-dev/rcs-ruby
   source_code_uri: https://github.com/pinnacle-dev/rcs-ruby
   changelog_uri: https://github.com/pinnacle-dev/rcs-ruby/blob/master/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -167,7 +173,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.6
-signing_key: 
+signing_key:
 specification_version: 4
 summary: ''
 test_files: []