rcs 1.0.15 → 1.0.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd6b24540486cc673f369e84cd9c3a56d58837b4143a11f79b0b8ad8d7056ee4
-  data.tar.gz: 708a541bf38d32fde5b6ef6d6338d9e3494f681f60d5811dbbc384e0bb58cf02
+  metadata.gz: 0cc0ed650419f2955313e2c91055c00a20c376af7b19fca0a067c575e39cb441
+  data.tar.gz: 0114e52c609971adb0f70222a9eda7be72ed2c21cbaab3edf6412a3586419c4d
 SHA512:
-  metadata.gz: b4fc78e103e1274d2ceac57826ce3bd7772901e5222fe486d2e133e3b2bd3570e26506db5438e699986b0a1bbdd9c0ae843e1e5fb8eef5f997e8df22886a2b8f
-  data.tar.gz: cf3dfa9bc7e5ad188baefef9983d6f1ac5230eafa3d08c9a9006581feb5f774bfd6213acdf0191f80f7985385fab06e2dccd6f8b00c684f637079052d2bd57c1
+  metadata.gz: f814ccaa8ebb9566fd17e1f5d067605f60ef77e5becb1e66c336eb6feda96aa42b384d3d04dcfb6ec89ae0e2d4e48d0516750b7c0c35fafc52cbb2faf139cb53
+  data.tar.gz: 1c5530bf2ad1d6589b6e445929ca77aa7dd0e80c726faa93cda11e4e335fb0002aa8bad60f9f2de9ca4d60f34b18a8a9118c3bf416b6d292412d5639654ab274

data/lib/rcs/tools/client.rb

@@ -0,0 +1,207 @@
+# 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).
+    #
+    # @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).
+    #
+    # @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.16" }
       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.16" }
       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

@@ -8,6 +8,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.16
 platform: ruby
 authors:
 - ''
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-11-29 00:00:00.000000000 Z
+date: 2024-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async-http-faraday
@@ -109,6 +109,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