rcs 1.0.18 → 2.0.0.pre.rc.2

data/lib/rcs/types/action.rb

@@ -1,154 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "action_type"
-require_relative "action_lat_long"
-require "ostruct"
-require "json"
-
-module Pinnacle
-  class Action
-    # @return [String] Title of the action (must be less than 25 characters).
-    attr_reader :title
-    # @return [Pinnacle::ActionType] Type of action for the button. 'openUrl' opens a URL, 'call' dials a phone
-    #  number, 'trigger' sends the predefined payload to the webhook when pressed,
-    #  'requestUserLocation' requests the user's location, 'scheduleEvent' creates a
-    #  calendar event, 'sendLocation' sends a location.
-    attr_reader :type
-    # @return [String] Optional payload associated with the action. This payload encodes the respective
-    #  fields for the action type and is required. For 'openUrl', the payload is the
-    #  URL to open. For 'call', the payload is the phone number to dial. For 'trigger',
-    #  the payload is the predefined payload to send to the webhook.
-    attr_reader :payload
-    # @return [String] Optional metadata. Only used for type 'trigger' ignored for other action types.
-    #  When the user presses the action, the metadata is sent to the webhook alongside
-    #  the payload.
-    attr_reader :metadata
-    # @return [String] Start time for events in ISO 8601 format. For example, '2022-01-01T12:00:00Z'.
-    #  Required for 'scheduleEvent'.
-    attr_reader :event_start_time
-    # @return [String] End time for events in ISO 8601 format. For example, '2022-01-01T12:00:00Z'.
-    #  Required for 'scheduleEvent'.
-    attr_reader :event_end_time
-    # @return [String] Event title. Required for 'scheduleEvent'.
-    attr_reader :event_title
-    # @return [String] Optional event description.
-    attr_reader :event_description
-    # @return [Pinnacle::ActionLatLong] Latitude and longitude coordinates. Required for 'sendLocation'.
-    attr_reader :lat_long
-    # @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] Title of the action (must be less than 25 characters).
-    # @param type [Pinnacle::ActionType] Type of action for the button. 'openUrl' opens a URL, 'call' dials a phone
-    #  number, 'trigger' sends the predefined payload to the webhook when pressed,
-    #  'requestUserLocation' requests the user's location, 'scheduleEvent' creates a
-    #  calendar event, 'sendLocation' sends a location.
-    # @param payload [String] Optional payload associated with the action. This payload encodes the respective
-    #  fields for the action type and is required. For 'openUrl', the payload is the
-    #  URL to open. For 'call', the payload is the phone number to dial. For 'trigger',
-    #  the payload is the predefined payload to send to the webhook.
-    # @param metadata [String] Optional metadata. Only used for type 'trigger' ignored for other action types.
-    #  When the user presses the action, the metadata is sent to the webhook alongside
-    #  the payload.
-    # @param event_start_time [String] Start time for events in ISO 8601 format. For example, '2022-01-01T12:00:00Z'.
-    #  Required for 'scheduleEvent'.
-    # @param event_end_time [String] End time for events in ISO 8601 format. For example, '2022-01-01T12:00:00Z'.
-    #  Required for 'scheduleEvent'.
-    # @param event_title [String] Event title. Required for 'scheduleEvent'.
-    # @param event_description [String] Optional event description.
-    # @param lat_long [Pinnacle::ActionLatLong] Latitude and longitude coordinates. Required for 'sendLocation'.
-    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-    # @return [Pinnacle::Action]
-    def initialize(title: OMIT, type: OMIT, payload: OMIT, metadata: OMIT, event_start_time: OMIT,
-                   event_end_time: OMIT, event_title: OMIT, event_description: OMIT, lat_long: OMIT, additional_properties: nil)
-      @title = title if title != OMIT
-      @type = type if type != OMIT
-      @payload = payload if payload != OMIT
-      @metadata = metadata if metadata != OMIT
-      @event_start_time = event_start_time if event_start_time != OMIT
-      @event_end_time = event_end_time if event_end_time != OMIT
-      @event_title = event_title if event_title != OMIT
-      @event_description = event_description if event_description != OMIT
-      @lat_long = lat_long if lat_long != OMIT
-      @additional_properties = additional_properties
-      @_field_set = {
-        "title": title,
-        "type": type,
-        "payload": payload,
-        "metadata": metadata,
-        "eventStartTime": event_start_time,
-        "eventEndTime": event_end_time,
-        "eventTitle": event_title,
-        "eventDescription": event_description,
-        "latLong": lat_long
-      }.reject do |_k, v|
-        v == OMIT
-      end
-    end
-
-    # Deserialize a JSON object to an instance of Action
-    #
-    # @param json_object [String]
-    # @return [Pinnacle::Action]
-    def self.from_json(json_object:)
-      struct = JSON.parse(json_object, object_class: OpenStruct)
-      parsed_json = JSON.parse(json_object)
-      title = parsed_json["title"]
-      type = parsed_json["type"]
-      payload = parsed_json["payload"]
-      metadata = parsed_json["metadata"]
-      event_start_time = parsed_json["eventStartTime"]
-      event_end_time = parsed_json["eventEndTime"]
-      event_title = parsed_json["eventTitle"]
-      event_description = parsed_json["eventDescription"]
-      if parsed_json["latLong"].nil?
-        lat_long = nil
-      else
-        lat_long = parsed_json["latLong"].to_json
-        lat_long = Pinnacle::ActionLatLong.from_json(json_object: lat_long)
-      end
-      new(
-        title: title,
-        type: type,
-        payload: payload,
-        metadata: metadata,
-        event_start_time: event_start_time,
-        event_end_time: event_end_time,
-        event_title: event_title,
-        event_description: event_description,
-        lat_long: lat_long,
-        additional_properties: struct
-      )
-    end
-
-    # Serialize an instance of Action 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.")
-      obj.type&.is_a?(Pinnacle::ActionType) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
-      obj.payload&.is_a?(String) != false || raise("Passed value for field obj.payload is not the expected type, validation failed.")
-      obj.metadata&.is_a?(String) != false || raise("Passed value for field obj.metadata 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_end_time&.is_a?(String) != false || raise("Passed value for field obj.event_end_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.event_description&.is_a?(String) != false || raise("Passed value for field obj.event_description is not the expected type, validation failed.")
-      obj.lat_long.nil? || Pinnacle::ActionLatLong.validate_raw(obj: obj.lat_long)
-    end
-  end
-end

data/lib/rcs/types/action_lat_long.rb

@@ -1,68 +0,0 @@
-# frozen_string_literal: true
-
-require "ostruct"
-require "json"
-
-module Pinnacle
-  # Latitude and longitude coordinates. Required for 'sendLocation'.
-  class ActionLatLong
-    # @return [Float] Latitude value.
-    attr_reader :lat
-    # @return [Float] Longitude value.
-    attr_reader :lng
-    # @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 lat [Float] Latitude value.
-    # @param lng [Float] Longitude value.
-    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-    # @return [Pinnacle::ActionLatLong]
-    def initialize(lat: OMIT, lng: OMIT, additional_properties: nil)
-      @lat = lat if lat != OMIT
-      @lng = lng if lng != OMIT
-      @additional_properties = additional_properties
-      @_field_set = { "lat": lat, "lng": lng }.reject do |_k, v|
-        v == OMIT
-      end
-    end
-
-    # Deserialize a JSON object to an instance of ActionLatLong
-    #
-    # @param json_object [String]
-    # @return [Pinnacle::ActionLatLong]
-    def self.from_json(json_object:)
-      struct = JSON.parse(json_object, object_class: OpenStruct)
-      parsed_json = JSON.parse(json_object)
-      lat = parsed_json["lat"]
-      lng = parsed_json["lng"]
-      new(
-        lat: lat,
-        lng: lng,
-        additional_properties: struct
-      )
-    end
-
-    # Serialize an instance of ActionLatLong 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.lat&.is_a?(Float) != false || raise("Passed value for field obj.lat is not the expected type, validation failed.")
-      obj.lng&.is_a?(Float) != false || raise("Passed value for field obj.lng is not the expected type, validation failed.")
-    end
-  end
-end

data/lib/rcs/types/action_type.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-module Pinnacle
-  # Type of action for the button. 'openUrl' opens a URL, 'call' dials a phone
-  #  number, 'trigger' sends the predefined payload to the webhook when pressed,
-  #  'requestUserLocation' requests the user's location, 'scheduleEvent' creates a
-  #  calendar event, 'sendLocation' sends a location.
-  class ActionType
-    OPEN_URL = "openUrl"
-    CALL = "call"
-    TRIGGER = "trigger"
-    REQUEST_USER_LOCATION = "requestUserLocation"
-    SCHEDULE_EVENT = "scheduleEvent"
-    SEND_LOCATION = "sendLocation"
-  end
-end

data/lib/rcs/types/additional_email.rb

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

data/lib/rcs/types/additional_phone_number.rb

@@ -1,65 +0,0 @@
-# frozen_string_literal: true
-
-require "ostruct"
-require "json"
-
-module Pinnacle
-  class AdditionalPhoneNumber
-    # @return [String] Additional phone number in international format.
-    attr_reader :phone
-    # @return [String] Label for the additional phone number.
-    attr_reader :label
-    # @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 phone [String] Additional phone number in international format.
-    # @param label [String] Label for the additional phone number.
-    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-    # @return [Pinnacle::AdditionalPhoneNumber]
-    def initialize(phone:, label:, additional_properties: nil)
-      @phone = phone
-      @label = label
-      @additional_properties = additional_properties
-      @_field_set = { "phone": phone, "label": label }
-    end
-
-    # Deserialize a JSON object to an instance of AdditionalPhoneNumber
-    #
-    # @param json_object [String]
-    # @return [Pinnacle::AdditionalPhoneNumber]
-    def self.from_json(json_object:)
-      struct = JSON.parse(json_object, object_class: OpenStruct)
-      parsed_json = JSON.parse(json_object)
-      phone = parsed_json["phone"]
-      label = parsed_json["label"]
-      new(
-        phone: phone,
-        label: label,
-        additional_properties: struct
-      )
-    end
-
-    # Serialize an instance of AdditionalPhoneNumber 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.phone.is_a?(String) != false || raise("Passed value for field obj.phone is not the expected type, validation failed.")
-      obj.label.is_a?(String) != false || raise("Passed value for field obj.label is not the expected type, validation failed.")
-    end
-  end
-end

data/lib/rcs/types/additional_website.rb

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

data/lib/rcs/types/card.rb

@@ -1,90 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "action"
-require "ostruct"
-require "json"
-
-module Pinnacle
-  class Card
-    # @return [String] The title of the card.
-    attr_reader :title
-    # @return [String] Optional subtitle for the card.
-    attr_reader :subtitle
-    # @return [String] Optional media URL displayed with the card.
-    attr_reader :media_url
-    # @return [Array<Pinnacle::Action>] Optional list of buttons on the card (max 4).
-    attr_reader :buttons
-    # @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] The title of the card.
-    # @param subtitle [String] Optional subtitle for the card.
-    # @param media_url [String] Optional media URL displayed with the card.
-    # @param buttons [Array<Pinnacle::Action>] Optional list of buttons on the card (max 4).
-    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-    # @return [Pinnacle::Card]
-    def initialize(title:, subtitle: OMIT, media_url: OMIT, buttons: OMIT, additional_properties: nil)
-      @title = title
-      @subtitle = subtitle if subtitle != OMIT
-      @media_url = media_url if media_url != OMIT
-      @buttons = buttons if buttons != OMIT
-      @additional_properties = additional_properties
-      @_field_set = {
-        "title": title,
-        "subtitle": subtitle,
-        "mediaUrl": media_url,
-        "buttons": buttons
-      }.reject do |_k, v|
-        v == OMIT
-      end
-    end
-
-    # Deserialize a JSON object to an instance of Card
-    #
-    # @param json_object [String]
-    # @return [Pinnacle::Card]
-    def self.from_json(json_object:)
-      struct = JSON.parse(json_object, object_class: OpenStruct)
-      parsed_json = JSON.parse(json_object)
-      title = parsed_json["title"]
-      subtitle = parsed_json["subtitle"]
-      media_url = parsed_json["mediaUrl"]
-      buttons = parsed_json["buttons"]&.map do |item|
-        item = item.to_json
-        Pinnacle::Action.from_json(json_object: item)
-      end
-      new(
-        title: title,
-        subtitle: subtitle,
-        media_url: media_url,
-        buttons: buttons,
-        additional_properties: struct
-      )
-    end
-
-    # Serialize an instance of Card 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.")
-      obj.subtitle&.is_a?(String) != false || raise("Passed value for field obj.subtitle is not the expected type, validation failed.")
-      obj.media_url&.is_a?(String) != false || raise("Passed value for field obj.media_url is not the expected type, validation failed.")
-      obj.buttons&.is_a?(Array) != false || raise("Passed value for field obj.buttons is not the expected type, validation failed.")
-    end
-  end
-end