rcs 1.0.18 → 2.0.0.pre.rc.2

data/lib/rcs/message/sms/client.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+require_relative "../../../requests"
+require_relative "../../types/sms_content"
+require_relative "../../types/sms_validation_result"
+require "async"
+
+module Pinnacle
+  module Message
+    class SmsClient
+      # @return [Pinnacle::RequestClient]
+      attr_reader :request_client
+
+      # @param request_client [Pinnacle::RequestClient]
+      # @return [Pinnacle::Message::SmsClient]
+      def initialize(request_client:)
+        @request_client = request_client
+      end
+
+      # Validate SMS message content without sending it.
+      #
+      # @param request [Hash] Request of type Pinnacle::Types::SmsContent, as a Hash
+      #   * :text (String)
+      # @param request_options [Pinnacle::RequestOptions]
+      # @return [Pinnacle::Types::SmsValidationResult]
+      # @example
+      #  api = Pinnacle::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: Pinnacle::Environment::DEFAULT,
+      #    api_key: "YOUR_API_KEY"
+      #  )
+      #  api.message.sms.validate(request: { text: "Hello from Pinnacle" })
+      def validate(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?
+          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 || {}), **(request_options&.additional_body_parameters || {}) }.compact
+          req.url "#{@request_client.get_url(request_options: request_options)}/messages/validate/sms"
+        end
+        Pinnacle::Types::SmsValidationResult.from_json(json_object: response.body)
+      end
+    end
+
+    class AsyncSmsClient
+      # @return [Pinnacle::AsyncRequestClient]
+      attr_reader :request_client
+
+      # @param request_client [Pinnacle::AsyncRequestClient]
+      # @return [Pinnacle::Message::AsyncSmsClient]
+      def initialize(request_client:)
+        @request_client = request_client
+      end
+
+      # Validate SMS message content without sending it.
+      #
+      # @param request [Hash] Request of type Pinnacle::Types::SmsContent, as a Hash
+      #   * :text (String)
+      # @param request_options [Pinnacle::RequestOptions]
+      # @return [Pinnacle::Types::SmsValidationResult]
+      # @example
+      #  api = Pinnacle::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: Pinnacle::Environment::DEFAULT,
+      #    api_key: "YOUR_API_KEY"
+      #  )
+      #  api.message.sms.validate(request: { text: "Hello from Pinnacle" })
+      def validate(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?
+            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 || {}), **(request_options&.additional_body_parameters || {}) }.compact
+            req.url "#{@request_client.get_url(request_options: request_options)}/messages/validate/sms"
+          end
+          Pinnacle::Types::SmsValidationResult.from_json(json_object: response.body)
+        end
+      end
+    end
+  end
+end

data/lib/rcs/messages/client.rb

@@ -0,0 +1,192 @@
+# frozen_string_literal: true
+
+require_relative "../../requests"
+require_relative "../types/message"
+require_relative "types/message_reaction_schema_options"
+require_relative "../types/reaction_result"
+require_relative "send/client"
+require "async"
+
+module Pinnacle
+  class MessagesClient
+    # @return [Pinnacle::RequestClient]
+    attr_reader :request_client
+    # @return [Pinnacle::Messages::SendClient]
+    attr_reader :send
+
+    # @param request_client [Pinnacle::RequestClient]
+    # @return [Pinnacle::MessagesClient]
+    def initialize(request_client:)
+      @request_client = request_client
+      @send = Pinnacle::Messages::SendClient.new(request_client: request_client)
+    end
+
+    # Retrieve a previously sent message.
+    #
+    # @param id [Integer] Unique identifier of the message.
+    # @param request_options [Pinnacle::RequestOptions]
+    # @return [Pinnacle::Types::Message]
+    # @example
+    #  api = Pinnacle::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: Pinnacle::Environment::DEFAULT,
+    #    api_key: "YOUR_API_KEY"
+    #  )
+    #  api.messages.get(id: 1240)
+    def get(id:, 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
+        unless request_options.nil? || request_options&.additional_query_parameters.nil?
+          req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+        end
+        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)}/messages/#{id}"
+      end
+      Pinnacle::Types::Message.from_json(json_object: response.body)
+    end
+
+    # Add or remove an emoji reaction to a previously sent message.
+    #
+    # @param message_id [Integer] Unique identifier of the message.
+    # @param options [Hash] Request of type Pinnacle::Messages::Types::MessageReactionSchemaOptions, as a Hash
+    #   * :force (Boolean)
+    # @param reaction [String] Unicode emoji to add. <br>
+    #  Use `null` to remove existing reaction.
+    # @param request_options [Pinnacle::RequestOptions]
+    # @return [Pinnacle::Types::ReactionResult]
+    # @example
+    #  api = Pinnacle::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: Pinnacle::Environment::DEFAULT,
+    #    api_key: "YOUR_API_KEY"
+    #  )
+    #  api.messages.react(
+    #    message_id: 1410,
+    #    options: { force: true },
+    #    reaction: "👍"
+    #  )
+    def react(message_id:, options: nil, reaction: 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 || {}),
+          messageId: message_id,
+          options: options,
+          reaction: reaction
+        }.compact
+        req.url "#{@request_client.get_url(request_options: request_options)}/messages/react"
+      end
+      Pinnacle::Types::ReactionResult.from_json(json_object: response.body)
+    end
+  end
+
+  class AsyncMessagesClient
+    # @return [Pinnacle::AsyncRequestClient]
+    attr_reader :request_client
+    # @return [Pinnacle::Messages::AsyncSendClient]
+    attr_reader :send
+
+    # @param request_client [Pinnacle::AsyncRequestClient]
+    # @return [Pinnacle::AsyncMessagesClient]
+    def initialize(request_client:)
+      @request_client = request_client
+      @send = Pinnacle::Messages::AsyncSendClient.new(request_client: request_client)
+    end
+
+    # Retrieve a previously sent message.
+    #
+    # @param id [Integer] Unique identifier of the message.
+    # @param request_options [Pinnacle::RequestOptions]
+    # @return [Pinnacle::Types::Message]
+    # @example
+    #  api = Pinnacle::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: Pinnacle::Environment::DEFAULT,
+    #    api_key: "YOUR_API_KEY"
+    #  )
+    #  api.messages.get(id: 1240)
+    def get(id:, request_options: nil)
+      Async do
+        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
+          unless request_options.nil? || request_options&.additional_query_parameters.nil?
+            req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+          end
+          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)}/messages/#{id}"
+        end
+        Pinnacle::Types::Message.from_json(json_object: response.body)
+      end
+    end
+
+    # Add or remove an emoji reaction to a previously sent message.
+    #
+    # @param message_id [Integer] Unique identifier of the message.
+    # @param options [Hash] Request of type Pinnacle::Messages::Types::MessageReactionSchemaOptions, as a Hash
+    #   * :force (Boolean)
+    # @param reaction [String] Unicode emoji to add. <br>
+    #  Use `null` to remove existing reaction.
+    # @param request_options [Pinnacle::RequestOptions]
+    # @return [Pinnacle::Types::ReactionResult]
+    # @example
+    #  api = Pinnacle::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: Pinnacle::Environment::DEFAULT,
+    #    api_key: "YOUR_API_KEY"
+    #  )
+    #  api.messages.react(
+    #    message_id: 1410,
+    #    options: { force: true },
+    #    reaction: "👍"
+    #  )
+    def react(message_id:, options: nil, reaction: 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 || {}),
+            messageId: message_id,
+            options: options,
+            reaction: reaction
+          }.compact
+          req.url "#{@request_client.get_url(request_options: request_options)}/messages/react"
+        end
+        Pinnacle::Types::ReactionResult.from_json(json_object: response.body)
+      end
+    end
+  end
+end

data/lib/rcs/messages/mms/client.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+require_relative "../../../requests"
+require_relative "../../types/mms_content"
+require_relative "../../types/mms_validation_result"
+require "async"
+
+module Pinnacle
+  module Messages
+    class MmsClient
+      # @return [Pinnacle::RequestClient]
+      attr_reader :request_client
+
+      # @param request_client [Pinnacle::RequestClient]
+      # @return [Pinnacle::Messages::MmsClient]
+      def initialize(request_client:)
+        @request_client = request_client
+      end
+
+      # Validate MMS message content without sending it.
+      #
+      # @param request [Hash] Request of type Pinnacle::Types::MmsContent, as a Hash
+      #   * :media_urls (Array<String>)
+      #   * :text (String)
+      # @param request_options [Pinnacle::RequestOptions]
+      # @return [Pinnacle::Types::MmsValidationResult]
+      # @example
+      #  api = Pinnacle::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: Pinnacle::Environment::DEFAULT,
+      #    api_key: "YOUR_API_KEY"
+      #  )
+      #  api.messages.mms.validate(request: { media_urls: ["https://upload.wikimedia.org/wikipedia/commons/b/b9/Pizigani_1367_Chart_1MB.jpg", "https://fastly.picsum.photos/id/528/1000/1000.jpg?hmac=aTG0xNif9KbNryFN0ZNZ_nFK6aEpZxqUGCZF1KjOT8w", "https://file-examples.com/storage/fefdd7ab126835e7993bb1a/2017/10/file_example_JPG_500kB.jpg"], text: "Check out these images!" })
+      def validate(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?
+          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 || {}), **(request_options&.additional_body_parameters || {}) }.compact
+          req.url "#{@request_client.get_url(request_options: request_options)}/messages/validate/mms"
+        end
+        Pinnacle::Types::MmsValidationResult.from_json(json_object: response.body)
+      end
+    end
+
+    class AsyncMmsClient
+      # @return [Pinnacle::AsyncRequestClient]
+      attr_reader :request_client
+
+      # @param request_client [Pinnacle::AsyncRequestClient]
+      # @return [Pinnacle::Messages::AsyncMmsClient]
+      def initialize(request_client:)
+        @request_client = request_client
+      end
+
+      # Validate MMS message content without sending it.
+      #
+      # @param request [Hash] Request of type Pinnacle::Types::MmsContent, as a Hash
+      #   * :media_urls (Array<String>)
+      #   * :text (String)
+      # @param request_options [Pinnacle::RequestOptions]
+      # @return [Pinnacle::Types::MmsValidationResult]
+      # @example
+      #  api = Pinnacle::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: Pinnacle::Environment::DEFAULT,
+      #    api_key: "YOUR_API_KEY"
+      #  )
+      #  api.messages.mms.validate(request: { media_urls: ["https://upload.wikimedia.org/wikipedia/commons/b/b9/Pizigani_1367_Chart_1MB.jpg", "https://fastly.picsum.photos/id/528/1000/1000.jpg?hmac=aTG0xNif9KbNryFN0ZNZ_nFK6aEpZxqUGCZF1KjOT8w", "https://file-examples.com/storage/fefdd7ab126835e7993bb1a/2017/10/file_example_JPG_500kB.jpg"], text: "Check out these images!" })
+      def validate(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?
+            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 || {}), **(request_options&.additional_body_parameters || {}) }.compact
+            req.url "#{@request_client.get_url(request_options: request_options)}/messages/validate/mms"
+          end
+          Pinnacle::Types::MmsValidationResult.from_json(json_object: response.body)
+        end
+      end
+    end
+  end
+end

data/lib/rcs/messages/rcs/client.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+require_relative "../../../requests"
+require_relative "../../types/rcs_validate_content"
+require_relative "../../types/rcs_validation_result"
+require "async"
+
+module Pinnacle
+  module Messages
+    class RcsClient
+      # @return [Pinnacle::RequestClient]
+      attr_reader :request_client
+
+      # @param request_client [Pinnacle::RequestClient]
+      # @return [Pinnacle::Messages::RcsClient]
+      def initialize(request_client:)
+        @request_client = request_client
+      end
+
+      # Validate RCS message content without sending it.
+      #
+      # @param request [Pinnacle::Types::RcsTextContent, Pinnacle::Types::RcsValidateContentMedia, Pinnacle::Types::RcsCards]
+      # @param request_options [Pinnacle::RequestOptions]
+      # @return [Pinnacle::Types::RcsValidationResult]
+      # @example
+      #  api = Pinnacle::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: Pinnacle::Environment::DEFAULT,
+      #    api_key: "YOUR_API_KEY"
+      #  )
+      #  api.messages.rcs.validate(request: { quick_replies: , text: "text" })
+      def validate(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?
+          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 || {}), **(request_options&.additional_body_parameters || {}) }.compact
+          req.url "#{@request_client.get_url(request_options: request_options)}/messages/validate/rcs"
+        end
+        Pinnacle::Types::RcsValidationResult.from_json(json_object: response.body)
+      end
+    end
+
+    class AsyncRcsClient
+      # @return [Pinnacle::AsyncRequestClient]
+      attr_reader :request_client
+
+      # @param request_client [Pinnacle::AsyncRequestClient]
+      # @return [Pinnacle::Messages::AsyncRcsClient]
+      def initialize(request_client:)
+        @request_client = request_client
+      end
+
+      # Validate RCS message content without sending it.
+      #
+      # @param request [Pinnacle::Types::RcsTextContent, Pinnacle::Types::RcsValidateContentMedia, Pinnacle::Types::RcsCards]
+      # @param request_options [Pinnacle::RequestOptions]
+      # @return [Pinnacle::Types::RcsValidationResult]
+      # @example
+      #  api = Pinnacle::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: Pinnacle::Environment::DEFAULT,
+      #    api_key: "YOUR_API_KEY"
+      #  )
+      #  api.messages.rcs.validate(request: { quick_replies: , text: "text" })
+      def validate(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?
+            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 || {}), **(request_options&.additional_body_parameters || {}) }.compact
+            req.url "#{@request_client.get_url(request_options: request_options)}/messages/validate/rcs"
+          end
+          Pinnacle::Types::RcsValidationResult.from_json(json_object: response.body)
+        end
+      end
+    end
+  end
+end