rcs 1.0.17 → 2.0.0.pre.rc.1

data/lib/rcs/types/rcs_base.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require_relative "rcs_base_options"
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    class RcsBase
+      # @return [String] Your RCS agent ID which must be prefixed with 'agent_'.
+      attr_reader :from
+      # @return [Pinnacle::Types::RcsBaseOptions] Configure how your RCS message is sent and tracked.
+      attr_reader :options
+      # @return [String] Recipient's phone number in E.164 format.
+      attr_reader :to
+      # @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 from [String] Your RCS agent ID which must be prefixed with 'agent_'.
+      # @param options [Pinnacle::Types::RcsBaseOptions] Configure how your RCS message is sent and tracked.
+      # @param to [String] Recipient's phone number in E.164 format.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::RcsBase]
+      def initialize(from:, to:, options: OMIT, additional_properties: nil)
+        @from = from
+        @options = options if options != OMIT
+        @to = to
+        @additional_properties = additional_properties
+        @_field_set = { "from": from, "options": options, "to": to }.reject do |_k, v|
+          v == OMIT
+        end
+      end
+
+      # Deserialize a JSON object to an instance of RcsBase
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::RcsBase]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        from = parsed_json["from"]
+        if parsed_json["options"].nil?
+          options = nil
+        else
+          options = parsed_json["options"].to_json
+          options = Pinnacle::Types::RcsBaseOptions.from_json(json_object: options)
+        end
+        to = parsed_json["to"]
+        new(
+          from: from,
+          options: options,
+          to: to,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of RcsBase 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.from.is_a?(String) != false || raise("Passed value for field obj.from is not the expected type, validation failed.")
+        obj.options.nil? || Pinnacle::Types::RcsBaseOptions.validate_raw(obj: obj.options)
+        obj.to.is_a?(String) != false || raise("Passed value for field obj.to is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/rcs/types/rcs_base_options.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+require_relative "message_schedule"
+require_relative "tracking"
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    # Configure how your RCS message is sent and tracked.
+    class RcsBaseOptions
+      # @return [Pinnacle::Types::MessageSchedule]
+      attr_reader :schedule
+      # @return [Boolean] Send via the test agent to whitelisted test devices. Useful for development and
+      #  debugging.
+      attr_reader :test_mode
+      # @return [Pinnacle::Types::Tracking]
+      attr_reader :tracking
+      # @return [Boolean] Validate your message for any unsupported files. <br>
+      #  If failed, errors will be thrown and the message will not send.
+      attr_reader :validate
+      # @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 test_mode [Boolean] Send via the test agent to whitelisted test devices. Useful for development and
+      #  debugging.
+      # @param tracking [Pinnacle::Types::Tracking]
+      # @param validate [Boolean] Validate your message for any unsupported files. <br>
+      #  If failed, errors will be thrown and the message will not send.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::RcsBaseOptions]
+      def initialize(schedule: OMIT, test_mode: OMIT, tracking: OMIT, validate: OMIT, additional_properties: nil)
+        @schedule = schedule if schedule != OMIT
+        @test_mode = test_mode if test_mode != OMIT
+        @tracking = tracking if tracking != OMIT
+        @validate = validate if validate != OMIT
+        @additional_properties = additional_properties
+        @_field_set = {
+          "schedule": schedule,
+          "test_mode": test_mode,
+          "tracking": tracking,
+          "validate": validate
+        }.reject do |_k, v|
+          v == OMIT
+        end
+      end
+
+      # Deserialize a JSON object to an instance of RcsBaseOptions
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::RcsBaseOptions]
+      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
+        test_mode = parsed_json["test_mode"]
+        tracking = parsed_json["tracking"]
+        validate = parsed_json["validate"]
+        new(
+          schedule: schedule,
+          test_mode: test_mode,
+          tracking: tracking,
+          validate: validate,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of RcsBaseOptions 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.test_mode&.is_a?(Boolean) != false || raise("Passed value for field obj.test_mode is not the expected type, validation failed.")
+        obj.tracking&.is_a?(Pinnacle::Types::Tracking) != false || raise("Passed value for field obj.tracking is not the expected type, validation failed.")
+        obj.validate&.is_a?(Boolean) != false || raise("Passed value for field obj.validate is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/rcs/types/rcs_button_call.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    # Button that initiates a phone call when tapped by the recipient.
+    class RcsButtonCall
+      # @return [String] Phone number to call in E.164 format
+      attr_reader :payload
+      # @return [String] Display text for the button.
+      attr_reader :title
+      # @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 payload [String] Phone number to call in E.164 format
+      # @param title [String] Display text for the button.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::RcsButtonCall]
+      def initialize(payload:, title:, additional_properties: nil)
+        @payload = payload
+        @title = title
+        @additional_properties = additional_properties
+        @_field_set = { "payload": payload, "title": title }
+      end
+
+      # Deserialize a JSON object to an instance of RcsButtonCall
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::RcsButtonCall]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        payload = parsed_json["payload"]
+        title = parsed_json["title"]
+        new(
+          payload: payload,
+          title: title,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of RcsButtonCall 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.payload.is_a?(String) != false || raise("Passed value for field obj.payload is not the expected type, validation failed.")
+        obj.title.is_a?(String) != false || raise("Passed value for field obj.title is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/rcs/types/rcs_button_content.rb

@@ -0,0 +1,148 @@
+# frozen_string_literal: true
+
+require "json"
+require_relative "rcs_button_open_url"
+require_relative "rcs_button_call"
+require_relative "rcs_button_trigger"
+require_relative "rcs_button_request_user_location"
+require_relative "rcs_button_schedule_event"
+require_relative "rcs_button_send_location"
+
+module Pinnacle
+  module Types
+    class RcsButtonContent
+      # @return [Object]
+      attr_reader :member
+      # @return [String]
+      attr_reader :discriminant
+
+      private_class_method :new
+      alias kind_of? is_a?
+
+      # @param member [Object]
+      # @param discriminant [String]
+      # @return [Pinnacle::Types::RcsButtonContent]
+      def initialize(member:, discriminant:)
+        @member = member
+        @discriminant = discriminant
+      end
+
+      # Deserialize a JSON object to an instance of RcsButtonContent
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::RcsButtonContent]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        member = case struct.type
+                 when "openUrl"
+                   Pinnacle::Types::RcsButtonOpenUrl.from_json(json_object: json_object)
+                 when "call"
+                   Pinnacle::Types::RcsButtonCall.from_json(json_object: json_object)
+                 when "trigger"
+                   Pinnacle::Types::RcsButtonTrigger.from_json(json_object: json_object)
+                 when "requestUserLocation"
+                   Pinnacle::Types::RcsButtonRequestUserLocation.from_json(json_object: json_object)
+                 when "scheduleEvent"
+                   Pinnacle::Types::RcsButtonScheduleEvent.from_json(json_object: json_object)
+                 when "sendLocation"
+                   Pinnacle::Types::RcsButtonSendLocation.from_json(json_object: json_object)
+                 else
+                   Pinnacle::Types::RcsButtonOpenUrl.from_json(json_object: json_object)
+                 end
+        new(member: member, discriminant: struct.type)
+      end
+
+      # For Union Types, to_json functionality is delegated to the wrapped member.
+      #
+      # @return [String]
+      def to_json(*_args)
+        case @discriminant
+        when "openUrl"
+          { **@member.to_json, type: @discriminant }.to_json
+        when "call"
+          { **@member.to_json, type: @discriminant }.to_json
+        when "trigger"
+          { **@member.to_json, type: @discriminant }.to_json
+        when "requestUserLocation"
+          { **@member.to_json, type: @discriminant }.to_json
+        when "scheduleEvent"
+          { **@member.to_json, type: @discriminant }.to_json
+        when "sendLocation"
+          { **@member.to_json, type: @discriminant }.to_json
+        else
+          { "type": @discriminant, value: @member }.to_json
+        end
+        @member.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:)
+        case obj.type
+        when "openUrl"
+          Pinnacle::Types::RcsButtonOpenUrl.validate_raw(obj: obj)
+        when "call"
+          Pinnacle::Types::RcsButtonCall.validate_raw(obj: obj)
+        when "trigger"
+          Pinnacle::Types::RcsButtonTrigger.validate_raw(obj: obj)
+        when "requestUserLocation"
+          Pinnacle::Types::RcsButtonRequestUserLocation.validate_raw(obj: obj)
+        when "scheduleEvent"
+          Pinnacle::Types::RcsButtonScheduleEvent.validate_raw(obj: obj)
+        when "sendLocation"
+          Pinnacle::Types::RcsButtonSendLocation.validate_raw(obj: obj)
+        else
+          raise("Passed value matched no type within the union, validation failed.")
+        end
+      end
+
+      # For Union Types, is_a? functionality is delegated to the wrapped member.
+      #
+      # @param obj [Object]
+      # @return [Boolean]
+      def is_a?(obj)
+        @member.is_a?(obj)
+      end
+
+      # @param member [Pinnacle::Types::RcsButtonOpenUrl]
+      # @return [Pinnacle::Types::RcsButtonContent]
+      def self.open_url(member:)
+        new(member: member, discriminant: "openUrl")
+      end
+
+      # @param member [Pinnacle::Types::RcsButtonCall]
+      # @return [Pinnacle::Types::RcsButtonContent]
+      def self.call(member:)
+        new(member: member, discriminant: "call")
+      end
+
+      # @param member [Pinnacle::Types::RcsButtonTrigger]
+      # @return [Pinnacle::Types::RcsButtonContent]
+      def self.trigger(member:)
+        new(member: member, discriminant: "trigger")
+      end
+
+      # @param member [Pinnacle::Types::RcsButtonRequestUserLocation]
+      # @return [Pinnacle::Types::RcsButtonContent]
+      def self.request_user_location(member:)
+        new(member: member, discriminant: "requestUserLocation")
+      end
+
+      # @param member [Pinnacle::Types::RcsButtonScheduleEvent]
+      # @return [Pinnacle::Types::RcsButtonContent]
+      def self.schedule_event(member:)
+        new(member: member, discriminant: "scheduleEvent")
+      end
+
+      # @param member [Pinnacle::Types::RcsButtonSendLocation]
+      # @return [Pinnacle::Types::RcsButtonContent]
+      def self.send_location(member:)
+        new(member: member, discriminant: "sendLocation")
+      end
+    end
+  end
+end

data/lib/rcs/types/rcs_button_open_url.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    # Button that opens a URL when tapped by the recipient.
+    class RcsButtonOpenUrl
+      # @return [String] The URL to open when the button is tapped. Must be a valid HTTP or HTTPS URL.
+      attr_reader :payload
+      # @return [String] Display text for the button.
+      attr_reader :title
+      # @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 payload [String] The URL to open when the button is tapped. Must be a valid HTTP or HTTPS URL.
+      # @param title [String] Display text for the button.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::RcsButtonOpenUrl]
+      def initialize(payload:, title:, additional_properties: nil)
+        @payload = payload
+        @title = title
+        @additional_properties = additional_properties
+        @_field_set = { "payload": payload, "title": title }
+      end
+
+      # Deserialize a JSON object to an instance of RcsButtonOpenUrl
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::RcsButtonOpenUrl]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        payload = parsed_json["payload"]
+        title = parsed_json["title"]
+        new(
+          payload: payload,
+          title: title,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of RcsButtonOpenUrl 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.payload.is_a?(String) != false || raise("Passed value for field obj.payload is not the expected type, validation failed.")
+        obj.title.is_a?(String) != false || raise("Passed value for field obj.title is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/rcs/types/rcs_button_request_user_location.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    # Button that prompts the recipient to share their current location.
+    class RcsButtonRequestUserLocation
+      # @return [String] Display text for the button.
+      attr_reader :title
+      # @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 title [String] Display text for the button.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::RcsButtonRequestUserLocation]
+      def initialize(title:, additional_properties: nil)
+        @title = title
+        @additional_properties = additional_properties
+        @_field_set = { "title": title }
+      end
+
+      # Deserialize a JSON object to an instance of RcsButtonRequestUserLocation
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::RcsButtonRequestUserLocation]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        title = parsed_json["title"]
+        new(title: title, additional_properties: struct)
+      end
+
+      # Serialize an instance of RcsButtonRequestUserLocation 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.title.is_a?(String) != false || raise("Passed value for field obj.title is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/rcs/types/rcs_button_schedule_event.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    # Button that prompts the recipient to add an event to their calendar.
+    class RcsButtonScheduleEvent
+      # @return [String] Detailed description for the calendar event.
+      attr_reader :event_description
+      # @return [String] End time in ISO 8601 format.
+      attr_reader :event_end_time
+      # @return [String] Starting time in ISO 8601 format.
+      attr_reader :event_start_time
+      # @return [String] Title of the event.
+      attr_reader :event_title
+      # @return [String] Display text for the button.
+      attr_reader :title
+      # @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 event_description [String] Detailed description for the calendar event.
+      # @param event_end_time [String] End time in ISO 8601 format.
+      # @param event_start_time [String] Starting time in ISO 8601 format.
+      # @param event_title [String] Title of the event.
+      # @param title [String] Display text for the button.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::RcsButtonScheduleEvent]
+      def initialize(event_end_time:, event_start_time:, event_title:, title:, event_description: OMIT,
+                     additional_properties: nil)
+        @event_description = event_description if event_description != OMIT
+        @event_end_time = event_end_time
+        @event_start_time = event_start_time
+        @event_title = event_title
+        @title = title
+        @additional_properties = additional_properties
+        @_field_set = {
+          "eventDescription": event_description,
+          "eventEndTime": event_end_time,
+          "eventStartTime": event_start_time,
+          "eventTitle": event_title,
+          "title": title
+        }.reject do |_k, v|
+          v == OMIT
+        end
+      end
+
+      # Deserialize a JSON object to an instance of RcsButtonScheduleEvent
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::RcsButtonScheduleEvent]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        event_description = parsed_json["eventDescription"]
+        event_end_time = parsed_json["eventEndTime"]
+        event_start_time = parsed_json["eventStartTime"]
+        event_title = parsed_json["eventTitle"]
+        title = parsed_json["title"]
+        new(
+          event_description: event_description,
+          event_end_time: event_end_time,
+          event_start_time: event_start_time,
+          event_title: event_title,
+          title: title,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of RcsButtonScheduleEvent 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.event_description&.is_a?(String) != false || raise("Passed value for field obj.event_description is not the expected type, validation failed.")
+        obj.event_end_time.is_a?(String) != false || raise("Passed value for field obj.event_end_time is not the expected type, validation failed.")
+        obj.event_start_time.is_a?(String) != false || raise("Passed value for field obj.event_start_time is not the expected type, validation failed.")
+        obj.event_title.is_a?(String) != false || raise("Passed value for field obj.event_title is not the expected type, validation failed.")
+        obj.title.is_a?(String) != false || raise("Passed value for field obj.title is not the expected type, validation failed.")
+      end
+    end
+  end
+end