rcs 1.0.17 → 2.0.0.pre.rc.1

data/lib/rcs/types/send_sms_response_segments.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require_relative "send_sms_response_segments_encoding"
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    # Details about how the message was segmented for sending.
+    class SendSmsResponseSegments
+      # @return [Float] Number of message segments used to send this message.
+      attr_reader :count
+      # @return [Pinnacle::Types::SendSmsResponseSegmentsEncoding] Encoding used for the message segments.
+      attr_reader :encoding
+      # @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 count [Float] Number of message segments used to send this message.
+      # @param encoding [Pinnacle::Types::SendSmsResponseSegmentsEncoding] Encoding used for the message segments.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::SendSmsResponseSegments]
+      def initialize(count:, encoding:, additional_properties: nil)
+        @count = count
+        @encoding = encoding
+        @additional_properties = additional_properties
+        @_field_set = { "count": count, "encoding": encoding }
+      end
+
+      # Deserialize a JSON object to an instance of SendSmsResponseSegments
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::SendSmsResponseSegments]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        count = parsed_json["count"]
+        encoding = parsed_json["encoding"]
+        new(
+          count: count,
+          encoding: encoding,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of SendSmsResponseSegments 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.count.is_a?(Float) != false || raise("Passed value for field obj.count is not the expected type, validation failed.")
+        obj.encoding.is_a?(Pinnacle::Types::SendSmsResponseSegmentsEncoding) != false || raise("Passed value for field obj.encoding is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/rcs/types/send_sms_response_segments_encoding.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Types
+    # Encoding used for the message segments.
+    class SendSmsResponseSegmentsEncoding
+      GSM_7 = "gsm7"
+      UTF_16 = "utf16"
+    end
+  end
+end

data/lib/rcs/types/sent_mms_details.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    class SentMmsDetails
+      # @return [Array<Integer>] Array of unique identifiers for the sent MMS messages.
+      attr_reader :message_ids
+      # @return [Float] Total number of segments used across the message.
+      attr_reader :segments
+      # @return [Float] Total cost of sending the message.
+      attr_reader :total_cost
+      # @return [String] Sender's phone number in E.164 format.
+      attr_reader :sender
+      # @return [String] Recipient's phone number in E.164 format.
+      attr_reader :recipient
+      # @return [String] Message is queued for delivery.
+      attr_reader :status
+      # @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 message_ids [Array<Integer>] Array of unique identifiers for the sent MMS messages.
+      # @param segments [Float] Total number of segments used across the message.
+      # @param total_cost [Float] Total cost of sending the message.
+      # @param sender [String] Sender's phone number in E.164 format.
+      # @param recipient [String] Recipient's phone number in E.164 format.
+      # @param status [String] Message is queued for delivery.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::SentMmsDetails]
+      def initialize(message_ids:, segments:, total_cost:, sender:, recipient:, status:, additional_properties: nil)
+        @message_ids = message_ids
+        @segments = segments
+        @total_cost = total_cost
+        @sender = sender
+        @recipient = recipient
+        @status = status
+        @additional_properties = additional_properties
+        @_field_set = {
+          "messageIds": message_ids,
+          "segments": segments,
+          "totalCost": total_cost,
+          "sender": sender,
+          "recipient": recipient,
+          "status": status
+        }
+      end
+
+      # Deserialize a JSON object to an instance of SentMmsDetails
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::SentMmsDetails]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        message_ids = parsed_json["messageIds"]
+        segments = parsed_json["segments"]
+        total_cost = parsed_json["totalCost"]
+        sender = parsed_json["sender"]
+        recipient = parsed_json["recipient"]
+        status = parsed_json["status"]
+        new(
+          message_ids: message_ids,
+          segments: segments,
+          total_cost: total_cost,
+          sender: sender,
+          recipient: recipient,
+          status: status,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of SentMmsDetails 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.message_ids.is_a?(Array) != false || raise("Passed value for field obj.message_ids is not the expected type, validation failed.")
+        obj.segments.is_a?(Float) != false || raise("Passed value for field obj.segments is not the expected type, validation failed.")
+        obj.total_cost.is_a?(Float) != false || raise("Passed value for field obj.total_cost is not the expected type, validation failed.")
+        obj.sender.is_a?(String) != false || raise("Passed value for field obj.sender is not the expected type, validation failed.")
+        obj.recipient.is_a?(String) != false || raise("Passed value for field obj.recipient is not the expected type, validation failed.")
+        obj.status.is_a?(String) != false || raise("Passed value for field obj.status is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/rcs/types/sent_rcs_details.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    class SentRcsDetails
+      # @return [Float] Unique identifier for the sent MMS messages.
+      attr_reader :message_ids
+      # @return [Integer] Total number of segments used across the message.
+      attr_reader :segments
+      # @return [Float] Total cost of sending the message.
+      attr_reader :total_cost
+      # @return [String] Sender's phone number in E.164 format.
+      attr_reader :sender
+      # @return [String] Recipient's phone number in E.164 format.
+      attr_reader :recipient
+      # @return [String] Current status of the message.
+      attr_reader :status
+      # @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 message_ids [Float] Unique identifier for the sent MMS messages.
+      # @param segments [Integer] Total number of segments used across the message.
+      # @param total_cost [Float] Total cost of sending the message.
+      # @param sender [String] Sender's phone number in E.164 format.
+      # @param recipient [String] Recipient's phone number in E.164 format.
+      # @param status [String] Current status of the message.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::SentRcsDetails]
+      def initialize(segments:, total_cost:, sender:, recipient:, status:, message_ids: OMIT,
+                     additional_properties: nil)
+        @message_ids = message_ids if message_ids != OMIT
+        @segments = segments
+        @total_cost = total_cost
+        @sender = sender
+        @recipient = recipient
+        @status = status
+        @additional_properties = additional_properties
+        @_field_set = {
+          "messageIds": message_ids,
+          "segments": segments,
+          "totalCost": total_cost,
+          "sender": sender,
+          "recipient": recipient,
+          "status": status
+        }.reject do |_k, v|
+          v == OMIT
+        end
+      end
+
+      # Deserialize a JSON object to an instance of SentRcsDetails
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::SentRcsDetails]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        message_ids = parsed_json["messageIds"]
+        segments = parsed_json["segments"]
+        total_cost = parsed_json["totalCost"]
+        sender = parsed_json["sender"]
+        recipient = parsed_json["recipient"]
+        status = parsed_json["status"]
+        new(
+          message_ids: message_ids,
+          segments: segments,
+          total_cost: total_cost,
+          sender: sender,
+          recipient: recipient,
+          status: status,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of SentRcsDetails 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.message_ids&.is_a?(Float) != false || raise("Passed value for field obj.message_ids is not the expected type, validation failed.")
+        obj.segments.is_a?(Integer) != false || raise("Passed value for field obj.segments is not the expected type, validation failed.")
+        obj.total_cost.is_a?(Float) != false || raise("Passed value for field obj.total_cost is not the expected type, validation failed.")
+        obj.sender.is_a?(String) != false || raise("Passed value for field obj.sender is not the expected type, validation failed.")
+        obj.recipient.is_a?(String) != false || raise("Passed value for field obj.recipient is not the expected type, validation failed.")
+        obj.status.is_a?(String) != false || raise("Passed value for field obj.status is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/rcs/types/sent_sms_details.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+require_relative "send_sms_response_segments"
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    class SentSmsDetails
+      # @return [Integer] Unique identifier for the sent message.
+      attr_reader :message_id
+      # @return [Pinnacle::Types::SendSmsResponseSegments] Details about how the message was segmented for sending.
+      attr_reader :segments
+      # @return [Float] Total cost of sending the message.
+      attr_reader :total_cost
+      # @return [String] Sender's phone number in E.164 format.
+      attr_reader :sender
+      # @return [String] Recipient's phone number in E.164 format.
+      attr_reader :recipient
+      # @return [String] Message is queued for delivery.
+      attr_reader :status
+      # @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 message_id [Integer] Unique identifier for the sent message.
+      # @param segments [Pinnacle::Types::SendSmsResponseSegments] Details about how the message was segmented for sending.
+      # @param total_cost [Float] Total cost of sending the message.
+      # @param sender [String] Sender's phone number in E.164 format.
+      # @param recipient [String] Recipient's phone number in E.164 format.
+      # @param status [String] Message is queued for delivery.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::SentSmsDetails]
+      def initialize(message_id:, segments:, total_cost:, sender:, recipient:, status:, additional_properties: nil)
+        @message_id = message_id
+        @segments = segments
+        @total_cost = total_cost
+        @sender = sender
+        @recipient = recipient
+        @status = status
+        @additional_properties = additional_properties
+        @_field_set = {
+          "messageId": message_id,
+          "segments": segments,
+          "totalCost": total_cost,
+          "sender": sender,
+          "recipient": recipient,
+          "status": status
+        }
+      end
+
+      # Deserialize a JSON object to an instance of SentSmsDetails
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::SentSmsDetails]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        message_id = parsed_json["messageId"]
+        if parsed_json["segments"].nil?
+          segments = nil
+        else
+          segments = parsed_json["segments"].to_json
+          segments = Pinnacle::Types::SendSmsResponseSegments.from_json(json_object: segments)
+        end
+        total_cost = parsed_json["totalCost"]
+        sender = parsed_json["sender"]
+        recipient = parsed_json["recipient"]
+        status = parsed_json["status"]
+        new(
+          message_id: message_id,
+          segments: segments,
+          total_cost: total_cost,
+          sender: sender,
+          recipient: recipient,
+          status: status,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of SentSmsDetails 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.message_id.is_a?(Integer) != false || raise("Passed value for field obj.message_id is not the expected type, validation failed.")
+        Pinnacle::Types::SendSmsResponseSegments.validate_raw(obj: obj.segments)
+        obj.total_cost.is_a?(Float) != false || raise("Passed value for field obj.total_cost is not the expected type, validation failed.")
+        obj.sender.is_a?(String) != false || raise("Passed value for field obj.sender is not the expected type, validation failed.")
+        obj.recipient.is_a?(String) != false || raise("Passed value for field obj.recipient is not the expected type, validation failed.")
+        obj.status.is_a?(String) != false || raise("Passed value for field obj.status is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/rcs/types/shortened_url.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require_relative "pinnacle_url_config"
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    class ShortenedUrl
+      # @return [String] Your custom shortened link following the format `https://pncl.to/{linkId}`,
+      #  where `{linkId}` is the unique identifier for the URL that can be used with our
+      #  other endpoint.
+      attr_reader :url
+      # @return [Pinnacle::Types::PinnacleUrlConfig]
+      attr_reader :config
+      # @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 url [String] Your custom shortened link following the format `https://pncl.to/{linkId}`,
+      #  where `{linkId}` is the unique identifier for the URL that can be used with our
+      #  other endpoint.
+      # @param config [Pinnacle::Types::PinnacleUrlConfig]
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::ShortenedUrl]
+      def initialize(url:, config:, additional_properties: nil)
+        @url = url
+        @config = config
+        @additional_properties = additional_properties
+        @_field_set = { "url": url, "config": config }
+      end
+
+      # Deserialize a JSON object to an instance of ShortenedUrl
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::ShortenedUrl]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        url = parsed_json["url"]
+        if parsed_json["config"].nil?
+          config = nil
+        else
+          config = parsed_json["config"].to_json
+          config = Pinnacle::Types::PinnacleUrlConfig.from_json(json_object: config)
+        end
+        new(
+          url: url,
+          config: config,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of ShortenedUrl 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.url.is_a?(String) != false || raise("Passed value for field obj.url is not the expected type, validation failed.")
+        Pinnacle::Types::PinnacleUrlConfig.validate_raw(obj: obj.config)
+      end
+    end
+  end
+end

data/lib/rcs/types/shortened_url_with_click_data.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+require_relative "link_click_event"
+require_relative "pinnacle_url_config"
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    class ShortenedUrlWithClickData
+      # @return [Array<Pinnacle::Types::LinkClickEvent>] Array of click analytics data for this URL. <br>
+      #  Click data will be empty if no one has visited your link yet.
+      attr_reader :clicks
+      # @return [String] Your custom shortened link following the format `https://pncl.to/{linkId}`,
+      #  where `{linkId}` is the unique identifier for the URL that can be used with our
+      #  other endpoint.
+      attr_reader :url
+      # @return [Pinnacle::Types::PinnacleUrlConfig]
+      attr_reader :config
+      # @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 clicks [Array<Pinnacle::Types::LinkClickEvent>] Array of click analytics data for this URL. <br>
+      #  Click data will be empty if no one has visited your link yet.
+      # @param url [String] Your custom shortened link following the format `https://pncl.to/{linkId}`,
+      #  where `{linkId}` is the unique identifier for the URL that can be used with our
+      #  other endpoint.
+      # @param config [Pinnacle::Types::PinnacleUrlConfig]
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::ShortenedUrlWithClickData]
+      def initialize(clicks:, url:, config:, additional_properties: nil)
+        @clicks = clicks
+        @url = url
+        @config = config
+        @additional_properties = additional_properties
+        @_field_set = { "clicks": clicks, "url": url, "config": config }
+      end
+
+      # Deserialize a JSON object to an instance of ShortenedUrlWithClickData
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::ShortenedUrlWithClickData]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        clicks = parsed_json["clicks"]&.map do |item|
+          item = item.to_json
+          Pinnacle::Types::LinkClickEvent.from_json(json_object: item)
+        end
+        url = parsed_json["url"]
+        if parsed_json["config"].nil?
+          config = nil
+        else
+          config = parsed_json["config"].to_json
+          config = Pinnacle::Types::PinnacleUrlConfig.from_json(json_object: config)
+        end
+        new(
+          clicks: clicks,
+          url: url,
+          config: config,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of ShortenedUrlWithClickData 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.clicks.is_a?(Array) != false || raise("Passed value for field obj.clicks is not the expected type, validation failed.")
+        obj.url.is_a?(String) != false || raise("Passed value for field obj.url is not the expected type, validation failed.")
+        Pinnacle::Types::PinnacleUrlConfig.validate_raw(obj: obj.config)
+      end
+    end
+  end
+end

data/lib/rcs/types/sms_content.rb

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