rcs 2.0.3 → 2.0.5.pre.rc.1

data/lib/rcs/messages/rcs/types/send_rich_message_response.rb

@@ -1,60 +0,0 @@
-# frozen_string_literal: true
-
-require "json"
-require_relative "../../../types/sent_rich_message"
-require_relative "../../../types/scheduled_message"
-
-module Pinnacle
-  module Messages
-    module Rcs
-      module Types
-        class SendRichMessageResponse
-          # Deserialize a JSON object to an instance of SendRichMessageResponse
-          #
-          # @param json_object [String]
-          # @return [Pinnacle::Messages::Rcs::Types::SendRichMessageResponse]
-          def self.from_json(json_object:)
-            struct = JSON.parse(json_object, object_class: OpenStruct)
-            begin
-              Pinnacle::Types::SentRichMessage.validate_raw(obj: struct)
-              return Pinnacle::Types::SentRichMessage.from_json(json_object: struct) unless struct.nil?
-
-              return nil
-            rescue StandardError
-              # noop
-            end
-            begin
-              Pinnacle::Types::ScheduledMessage.validate_raw(obj: struct)
-              return Pinnacle::Types::ScheduledMessage.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::Types::SentRichMessage.validate_raw(obj: obj)
-            rescue StandardError
-              # noop
-            end
-            begin
-              return Pinnacle::Types::ScheduledMessage.validate_raw(obj: obj)
-            rescue StandardError
-              # noop
-            end
-            raise("Passed value matched no type within the union, validation failed.")
-          end
-        end
-      end
-    end
-  end
-end

data/lib/rcs/messages/rcs/types/send_typing_indicator_schema_options.rb

@@ -1,66 +0,0 @@
-# frozen_string_literal: true
-
-require "ostruct"
-require "json"
-
-module Pinnacle
-  module Messages
-    module Rcs
-      module Types
-        # Configure how your typing indicator is sent.
-        class SendTypingIndicatorSchemaOptions
-          # @return [Boolean] Send via the test agent to whitelisted test devices. Useful for development and
-          #  debugging.
-          attr_reader :test_mode
-          # @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 test_mode [Boolean] Send via the test agent to whitelisted test devices. Useful for development and
-          #  debugging.
-          # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-          # @return [Pinnacle::Messages::Rcs::Types::SendTypingIndicatorSchemaOptions]
-          def initialize(test_mode: OMIT, additional_properties: nil)
-            @test_mode = test_mode if test_mode != OMIT
-            @additional_properties = additional_properties
-            @_field_set = { "test_mode": test_mode }.reject do |_k, v|
-              v == OMIT
-            end
-          end
-
-          # Deserialize a JSON object to an instance of SendTypingIndicatorSchemaOptions
-          #
-          # @param json_object [String]
-          # @return [Pinnacle::Messages::Rcs::Types::SendTypingIndicatorSchemaOptions]
-          def self.from_json(json_object:)
-            struct = JSON.parse(json_object, object_class: OpenStruct)
-            parsed_json = JSON.parse(json_object)
-            test_mode = parsed_json["test_mode"]
-            new(test_mode: test_mode, additional_properties: struct)
-          end
-
-          # Serialize an instance of SendTypingIndicatorSchemaOptions 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.test_mode&.is_a?(Boolean) != false || raise("Passed value for field obj.test_mode is not the expected type, validation failed.")
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,103 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "../../../requests"
-require_relative "../../types/schedule_cancel_result"
-require "async"
-
-module Pinnacle
-  module Messages
-    class ScheduleClient
-      # @return [Pinnacle::RequestClient]
-      attr_reader :request_client
-
-      # @param request_client [Pinnacle::RequestClient]
-      # @return [Pinnacle::Messages::ScheduleClient]
-      def initialize(request_client:)
-        @request_client = request_client
-      end
-
-      # Cancel a scheduled message or blast. <br>
-      #  Works for both individual scheduled messages and scheduled blasts. Use the
-      #  `scheduleId` returned when the message or blast was scheduled.
-      #
-      # @param id [String] Unique identifier of the scheduled message. This identifier is a string that
-      #  always begins with the prefix `msg_sched_`, for example: `msg_sched_1234567890`.
-      # @param request_options [Pinnacle::RequestOptions]
-      # @return [Pinnacle::Types::ScheduleCancelResult]
-      # @example
-      #  api = Pinnacle::Client.new(
-      #    base_url: "https://api.example.com",
-      #    environment: Pinnacle::Environment::DEFAULT,
-      #    api_key: "YOUR_API_KEY"
-      #  )
-      #  api.messages.schedule.cancel(id: "id")
-      def cancel(id:, request_options: nil)
-        response = @request_client.conn.delete 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/schedule/#{id}"
-        end
-        Pinnacle::Types::ScheduleCancelResult.from_json(json_object: response.body)
-      end
-    end
-
-    class AsyncScheduleClient
-      # @return [Pinnacle::AsyncRequestClient]
-      attr_reader :request_client
-
-      # @param request_client [Pinnacle::AsyncRequestClient]
-      # @return [Pinnacle::Messages::AsyncScheduleClient]
-      def initialize(request_client:)
-        @request_client = request_client
-      end
-
-      # Cancel a scheduled message or blast. <br>
-      #  Works for both individual scheduled messages and scheduled blasts. Use the
-      #  `scheduleId` returned when the message or blast was scheduled.
-      #
-      # @param id [String] Unique identifier of the scheduled message. This identifier is a string that
-      #  always begins with the prefix `msg_sched_`, for example: `msg_sched_1234567890`.
-      # @param request_options [Pinnacle::RequestOptions]
-      # @return [Pinnacle::Types::ScheduleCancelResult]
-      # @example
-      #  api = Pinnacle::Client.new(
-      #    base_url: "https://api.example.com",
-      #    environment: Pinnacle::Environment::DEFAULT,
-      #    api_key: "YOUR_API_KEY"
-      #  )
-      #  api.messages.schedule.cancel(id: "id")
-      def cancel(id:, request_options: nil)
-        Async do
-          response = @request_client.conn.delete 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/schedule/#{id}"
-          end
-          Pinnacle::Types::ScheduleCancelResult.from_json(json_object: response.body)
-        end
-      end
-    end
-  end
-end

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

@@ -1,198 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "../../../requests"
-require_relative "types/send_sms_options"
-require_relative "types/sms_send_response"
-require_relative "../../types/sms_content"
-require_relative "../../types/sms_validation_result"
-require "async"
-
-module Pinnacle
-  module Messages
-    class SmsClient
-      # @return [Pinnacle::RequestClient]
-      attr_reader :request_client
-
-      # @param request_client [Pinnacle::RequestClient]
-      # @return [Pinnacle::Messages::SmsClient]
-      def initialize(request_client:)
-        @request_client = request_client
-      end
-
-      # Send a SMS message immediately or schedule it for future delivery.
-      #
-      # @param from [String] Phone number that sends the message in E.164 format.
-      # @param options [Hash] Additional settings to customize SMS delivery.Request of type Pinnacle::Messages::Sms::Types::SendSmsOptions, as a Hash
-      #   * :schedule (Hash)
-      #     * :send_at (String)
-      #     * :recurrence (String)
-      #     * :timezone (String)
-      #     * :end_date (String)
-      #   * :tracking (Pinnacle::Types::Tracking)
-      # @param text [String] Message content.
-      # @param to [String] Recipient's phone number in E.164 format.
-      # @param request_options [Pinnacle::RequestOptions]
-      # @return [Pinnacle::Types::SentSmsDetails, Pinnacle::Types::ScheduledMessage]
-      # @example
-      #  api = Pinnacle::Client.new(
-      #    base_url: "https://api.example.com",
-      #    environment: Pinnacle::Environment::DEFAULT,
-      #    api_key: "YOUR_API_KEY"
-      #  )
-      #  api.messages.sms.send_(
-      #    from: "+14155164736",
-      #    text: "Hey!",
-      #    to: "+14154746461"
-      #  )
-      def send_(from:, text:, to:, options: 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 || {}),
-            from: from,
-            options: options,
-            text: text,
-            to: to
-          }.compact
-          req.url "#{@request_client.get_url(request_options: request_options)}/messages/send/sms"
-        end
-        Pinnacle::Messages::Sms::Types::SmsSendResponse.from_json(json_object: response.body)
-      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.messages.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::Messages::AsyncSmsClient]
-      def initialize(request_client:)
-        @request_client = request_client
-      end
-
-      # Send a SMS message immediately or schedule it for future delivery.
-      #
-      # @param from [String] Phone number that sends the message in E.164 format.
-      # @param options [Hash] Additional settings to customize SMS delivery.Request of type Pinnacle::Messages::Sms::Types::SendSmsOptions, as a Hash
-      #   * :schedule (Hash)
-      #     * :send_at (String)
-      #     * :recurrence (String)
-      #     * :timezone (String)
-      #     * :end_date (String)
-      #   * :tracking (Pinnacle::Types::Tracking)
-      # @param text [String] Message content.
-      # @param to [String] Recipient's phone number in E.164 format.
-      # @param request_options [Pinnacle::RequestOptions]
-      # @return [Pinnacle::Types::SentSmsDetails, Pinnacle::Types::ScheduledMessage]
-      # @example
-      #  api = Pinnacle::Client.new(
-      #    base_url: "https://api.example.com",
-      #    environment: Pinnacle::Environment::DEFAULT,
-      #    api_key: "YOUR_API_KEY"
-      #  )
-      #  api.messages.sms.send_(
-      #    from: "+14155164736",
-      #    text: "Hey!",
-      #    to: "+14154746461"
-      #  )
-      def send_(from:, text:, to:, options: 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 || {}),
-              from: from,
-              options: options,
-              text: text,
-              to: to
-            }.compact
-            req.url "#{@request_client.get_url(request_options: request_options)}/messages/send/sms"
-          end
-          Pinnacle::Messages::Sms::Types::SmsSendResponse.from_json(json_object: response.body)
-        end
-      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.messages.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/sms/types/send_sms_options.rb

@@ -1,81 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "../../../types/message_schedule"
-require_relative "../../../types/tracking"
-require "ostruct"
-require "json"
-
-module Pinnacle
-  module Messages
-    module Sms
-      module Types
-        # Additional settings to customize SMS delivery.
-        class SendSmsOptions
-          # @return [Pinnacle::Types::MessageSchedule]
-          attr_reader :schedule
-          # @return [Pinnacle::Types::Tracking]
-          attr_reader :tracking
-          # @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 schedule [Pinnacle::Types::MessageSchedule]
-          # @param tracking [Pinnacle::Types::Tracking]
-          # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-          # @return [Pinnacle::Messages::Sms::Types::SendSmsOptions]
-          def initialize(schedule: OMIT, tracking: OMIT, additional_properties: nil)
-            @schedule = schedule if schedule != OMIT
-            @tracking = tracking if tracking != OMIT
-            @additional_properties = additional_properties
-            @_field_set = { "schedule": schedule, "tracking": tracking }.reject do |_k, v|
-              v == OMIT
-            end
-          end
-
-          # Deserialize a JSON object to an instance of SendSmsOptions
-          #
-          # @param json_object [String]
-          # @return [Pinnacle::Messages::Sms::Types::SendSmsOptions]
-          def self.from_json(json_object:)
-            struct = JSON.parse(json_object, object_class: OpenStruct)
-            parsed_json = JSON.parse(json_object)
-            if parsed_json["schedule"].nil?
-              schedule = nil
-            else
-              schedule = parsed_json["schedule"].to_json
-              schedule = Pinnacle::Types::MessageSchedule.from_json(json_object: schedule)
-            end
-            tracking = parsed_json["tracking"]
-            new(
-              schedule: schedule,
-              tracking: tracking,
-              additional_properties: struct
-            )
-          end
-
-          # Serialize an instance of SendSmsOptions 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.schedule.nil? || Pinnacle::Types::MessageSchedule.validate_raw(obj: obj.schedule)
-            obj.tracking&.is_a?(Pinnacle::Types::Tracking) != false || raise("Passed value for field obj.tracking is not the expected type, validation failed.")
-          end
-        end
-      end
-    end
-  end
-end

data/lib/rcs/messages/sms/types/sms_send_response.rb

@@ -1,60 +0,0 @@
-# frozen_string_literal: true
-
-require "json"
-require_relative "../../../types/sent_sms_details"
-require_relative "../../../types/scheduled_message"
-
-module Pinnacle
-  module Messages
-    module Sms
-      module Types
-        class SmsSendResponse
-          # Deserialize a JSON object to an instance of SmsSendResponse
-          #
-          # @param json_object [String]
-          # @return [Pinnacle::Messages::Sms::Types::SmsSendResponse]
-          def self.from_json(json_object:)
-            struct = JSON.parse(json_object, object_class: OpenStruct)
-            begin
-              Pinnacle::Types::SentSmsDetails.validate_raw(obj: struct)
-              return Pinnacle::Types::SentSmsDetails.from_json(json_object: struct) unless struct.nil?
-
-              return nil
-            rescue StandardError
-              # noop
-            end
-            begin
-              Pinnacle::Types::ScheduledMessage.validate_raw(obj: struct)
-              return Pinnacle::Types::ScheduledMessage.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::Types::SentSmsDetails.validate_raw(obj: obj)
-            rescue StandardError
-              # noop
-            end
-            begin
-              return Pinnacle::Types::ScheduledMessage.validate_raw(obj: obj)
-            rescue StandardError
-              # noop
-            end
-            raise("Passed value matched no type within the union, validation failed.")
-          end
-        end
-      end
-    end
-  end
-end

data/lib/rcs/messages/types/react_message_options.rb

@@ -1,71 +0,0 @@
-# frozen_string_literal: true
-
-require "ostruct"
-require "json"
-
-module Pinnacle
-  module Messages
-    module Types
-      class ReactMessageOptions
-        # @return [Boolean] By default, only messages sent with the `options.tracking` field can be
-        #  precisely reacted to. <br>
-        #  Set `options.force` to true to bypass this restriction (may react to a different
-        #  message). <br>
-        #  For MMS and RCS, only messages containing text can be tracked. Otherwise,
-        #  `options.force` is ignored.
-        attr_reader :force
-        # @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 force [Boolean] By default, only messages sent with the `options.tracking` field can be
-        #  precisely reacted to. <br>
-        #  Set `options.force` to true to bypass this restriction (may react to a different
-        #  message). <br>
-        #  For MMS and RCS, only messages containing text can be tracked. Otherwise,
-        #  `options.force` is ignored.
-        # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-        # @return [Pinnacle::Messages::Types::ReactMessageOptions]
-        def initialize(force: OMIT, additional_properties: nil)
-          @force = force if force != OMIT
-          @additional_properties = additional_properties
-          @_field_set = { "force": force }.reject do |_k, v|
-            v == OMIT
-          end
-        end
-
-        # Deserialize a JSON object to an instance of ReactMessageOptions
-        #
-        # @param json_object [String]
-        # @return [Pinnacle::Messages::Types::ReactMessageOptions]
-        def self.from_json(json_object:)
-          struct = JSON.parse(json_object, object_class: OpenStruct)
-          parsed_json = JSON.parse(json_object)
-          force = parsed_json["force"]
-          new(force: force, additional_properties: struct)
-        end
-
-        # Serialize an instance of ReactMessageOptions 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.force&.is_a?(Boolean) != false || raise("Passed value for field obj.force is not the expected type, validation failed.")
-        end
-      end
-    end
-  end
-end