rcs 1.0.18 → 2.0.0.pre.rc.1

data/lib/rcs/types/company_details.rb

@@ -1,120 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "company_category"
-require "ostruct"
-require "json"
-
-module Pinnacle
-  class CompanyDetails
-    # @return [String] The name of the company.
-    attr_reader :name
-    # @return [Pinnacle::CompanyCategory] The category of the company.
-    attr_reader :category
-    # @return [String] The address of the company.
-    attr_reader :address
-    # @return [String] The EIN (Employer Identification Number) of the company.
-    attr_reader :ein
-    # @return [String] A description of the company.
-    attr_reader :description
-    # @return [String] The brand color in hex format, must pass a contrast ratio of at least 4.5:1 with
-    #  white.
-    attr_reader :brand_color
-    # @return [String] URL of the company logo.
-    attr_reader :logo_url
-    # @return [String] URL of the company's hero image.
-    attr_reader :hero_url
-    # @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 name [String] The name of the company.
-    # @param category [Pinnacle::CompanyCategory] The category of the company.
-    # @param address [String] The address of the company.
-    # @param ein [String] The EIN (Employer Identification Number) of the company.
-    # @param description [String] A description of the company.
-    # @param brand_color [String] The brand color in hex format, must pass a contrast ratio of at least 4.5:1 with
-    #  white.
-    # @param logo_url [String] URL of the company logo.
-    # @param hero_url [String] URL of the company's hero image.
-    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-    # @return [Pinnacle::CompanyDetails]
-    def initialize(name:, category:, address:, ein:, description:, brand_color:, logo_url:, hero_url:,
-                   additional_properties: nil)
-      @name = name
-      @category = category
-      @address = address
-      @ein = ein
-      @description = description
-      @brand_color = brand_color
-      @logo_url = logo_url
-      @hero_url = hero_url
-      @additional_properties = additional_properties
-      @_field_set = {
-        "name": name,
-        "category": category,
-        "address": address,
-        "ein": ein,
-        "description": description,
-        "brandColor": brand_color,
-        "logoUrl": logo_url,
-        "heroUrl": hero_url
-      }
-    end
-
-    # Deserialize a JSON object to an instance of CompanyDetails
-    #
-    # @param json_object [String]
-    # @return [Pinnacle::CompanyDetails]
-    def self.from_json(json_object:)
-      struct = JSON.parse(json_object, object_class: OpenStruct)
-      parsed_json = JSON.parse(json_object)
-      name = parsed_json["name"]
-      category = parsed_json["category"]
-      address = parsed_json["address"]
-      ein = parsed_json["ein"]
-      description = parsed_json["description"]
-      brand_color = parsed_json["brandColor"]
-      logo_url = parsed_json["logoUrl"]
-      hero_url = parsed_json["heroUrl"]
-      new(
-        name: name,
-        category: category,
-        address: address,
-        ein: ein,
-        description: description,
-        brand_color: brand_color,
-        logo_url: logo_url,
-        hero_url: hero_url,
-        additional_properties: struct
-      )
-    end
-
-    # Serialize an instance of CompanyDetails 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.name.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
-      obj.category.is_a?(Pinnacle::CompanyCategory) != false || raise("Passed value for field obj.category is not the expected type, validation failed.")
-      obj.address.is_a?(String) != false || raise("Passed value for field obj.address is not the expected type, validation failed.")
-      obj.ein.is_a?(String) != false || raise("Passed value for field obj.ein is not the expected type, validation failed.")
-      obj.description.is_a?(String) != false || raise("Passed value for field obj.description is not the expected type, validation failed.")
-      obj.brand_color.is_a?(String) != false || raise("Passed value for field obj.brand_color is not the expected type, validation failed.")
-      obj.logo_url.is_a?(String) != false || raise("Passed value for field obj.logo_url is not the expected type, validation failed.")
-      obj.hero_url.is_a?(String) != false || raise("Passed value for field obj.hero_url is not the expected type, validation failed.")
-    end
-  end
-end

data/lib/rcs/types/forbidden_error_body.rb

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

data/lib/rcs/types/inbound_action_message.rb

@@ -1,117 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "inbound_message_metadata"
-require "ostruct"
-require "json"
-
-module Pinnacle
-  class InboundActionMessage
-    # @return [String]
-    attr_reader :message_type
-    # @return [String]
-    attr_reader :action_title
-    # @return [String]
-    attr_reader :payload
-    # @return [String]
-    attr_reader :action_metadata
-    # @return [String]
-    attr_reader :from
-    # @return [String]
-    attr_reader :to
-    # @return [Pinnacle::InboundMessageMetadata]
-    attr_reader :metadata
-    # @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_type [String]
-    # @param action_title [String]
-    # @param payload [String]
-    # @param action_metadata [String]
-    # @param from [String]
-    # @param to [String]
-    # @param metadata [Pinnacle::InboundMessageMetadata]
-    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-    # @return [Pinnacle::InboundActionMessage]
-    def initialize(action_title:, from:, to:, message_type: OMIT, payload: OMIT, action_metadata: OMIT, metadata: OMIT,
-                   additional_properties: nil)
-      @message_type = message_type if message_type != OMIT
-      @action_title = action_title
-      @payload = payload if payload != OMIT
-      @action_metadata = action_metadata if action_metadata != OMIT
-      @from = from
-      @to = to
-      @metadata = metadata if metadata != OMIT
-      @additional_properties = additional_properties
-      @_field_set = {
-        "messageType": message_type,
-        "actionTitle": action_title,
-        "payload": payload,
-        "actionMetadata": action_metadata,
-        "from": from,
-        "to": to,
-        "metadata": metadata
-      }.reject do |_k, v|
-        v == OMIT
-      end
-    end
-
-    # Deserialize a JSON object to an instance of InboundActionMessage
-    #
-    # @param json_object [String]
-    # @return [Pinnacle::InboundActionMessage]
-    def self.from_json(json_object:)
-      struct = JSON.parse(json_object, object_class: OpenStruct)
-      parsed_json = JSON.parse(json_object)
-      message_type = parsed_json["messageType"]
-      action_title = parsed_json["actionTitle"]
-      payload = parsed_json["payload"]
-      action_metadata = parsed_json["actionMetadata"]
-      from = parsed_json["from"]
-      to = parsed_json["to"]
-      if parsed_json["metadata"].nil?
-        metadata = nil
-      else
-        metadata = parsed_json["metadata"].to_json
-        metadata = Pinnacle::InboundMessageMetadata.from_json(json_object: metadata)
-      end
-      new(
-        message_type: message_type,
-        action_title: action_title,
-        payload: payload,
-        action_metadata: action_metadata,
-        from: from,
-        to: to,
-        metadata: metadata,
-        additional_properties: struct
-      )
-    end
-
-    # Serialize an instance of InboundActionMessage 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_type&.is_a?(String) != false || raise("Passed value for field obj.message_type is not the expected type, validation failed.")
-      obj.action_title.is_a?(String) != false || raise("Passed value for field obj.action_title 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.action_metadata&.is_a?(String) != false || raise("Passed value for field obj.action_metadata is not the expected type, validation failed.")
-      obj.from.is_a?(String) != false || raise("Passed value for field obj.from is not the expected type, validation failed.")
-      obj.to.is_a?(String) != false || raise("Passed value for field obj.to is not the expected type, validation failed.")
-      obj.metadata.nil? || Pinnacle::InboundMessageMetadata.validate_raw(obj: obj.metadata)
-    end
-  end
-end

data/lib/rcs/types/inbound_location_message.rb

@@ -1,106 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "inbound_location_message_coordinates"
-require_relative "inbound_message_metadata"
-require "ostruct"
-require "json"
-
-module Pinnacle
-  class InboundLocationMessage
-    # @return [String]
-    attr_reader :message_type
-    # @return [Pinnacle::InboundLocationMessageCoordinates]
-    attr_reader :coordinates
-    # @return [String]
-    attr_reader :from
-    # @return [String]
-    attr_reader :to
-    # @return [Pinnacle::InboundMessageMetadata]
-    attr_reader :metadata
-    # @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_type [String]
-    # @param coordinates [Pinnacle::InboundLocationMessageCoordinates]
-    # @param from [String]
-    # @param to [String]
-    # @param metadata [Pinnacle::InboundMessageMetadata]
-    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-    # @return [Pinnacle::InboundLocationMessage]
-    def initialize(coordinates:, from:, to:, message_type: OMIT, metadata: OMIT, additional_properties: nil)
-      @message_type = message_type if message_type != OMIT
-      @coordinates = coordinates
-      @from = from
-      @to = to
-      @metadata = metadata if metadata != OMIT
-      @additional_properties = additional_properties
-      @_field_set = {
-        "messageType": message_type,
-        "coordinates": coordinates,
-        "from": from,
-        "to": to,
-        "metadata": metadata
-      }.reject do |_k, v|
-        v == OMIT
-      end
-    end
-
-    # Deserialize a JSON object to an instance of InboundLocationMessage
-    #
-    # @param json_object [String]
-    # @return [Pinnacle::InboundLocationMessage]
-    def self.from_json(json_object:)
-      struct = JSON.parse(json_object, object_class: OpenStruct)
-      parsed_json = JSON.parse(json_object)
-      message_type = parsed_json["messageType"]
-      if parsed_json["coordinates"].nil?
-        coordinates = nil
-      else
-        coordinates = parsed_json["coordinates"].to_json
-        coordinates = Pinnacle::InboundLocationMessageCoordinates.from_json(json_object: coordinates)
-      end
-      from = parsed_json["from"]
-      to = parsed_json["to"]
-      if parsed_json["metadata"].nil?
-        metadata = nil
-      else
-        metadata = parsed_json["metadata"].to_json
-        metadata = Pinnacle::InboundMessageMetadata.from_json(json_object: metadata)
-      end
-      new(
-        message_type: message_type,
-        coordinates: coordinates,
-        from: from,
-        to: to,
-        metadata: metadata,
-        additional_properties: struct
-      )
-    end
-
-    # Serialize an instance of InboundLocationMessage 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_type&.is_a?(String) != false || raise("Passed value for field obj.message_type is not the expected type, validation failed.")
-      Pinnacle::InboundLocationMessageCoordinates.validate_raw(obj: obj.coordinates)
-      obj.from.is_a?(String) != false || raise("Passed value for field obj.from is not the expected type, validation failed.")
-      obj.to.is_a?(String) != false || raise("Passed value for field obj.to is not the expected type, validation failed.")
-      obj.metadata.nil? || Pinnacle::InboundMessageMetadata.validate_raw(obj: obj.metadata)
-    end
-  end
-end

data/lib/rcs/types/inbound_location_message_coordinates.rb

@@ -1,65 +0,0 @@
-# frozen_string_literal: true
-
-require "ostruct"
-require "json"
-
-module Pinnacle
-  class InboundLocationMessageCoordinates
-    # @return [Float]
-    attr_reader :lat
-    # @return [Float]
-    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]
-    # @param lng [Float]
-    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-    # @return [Pinnacle::InboundLocationMessageCoordinates]
-    def initialize(lat:, lng:, additional_properties: nil)
-      @lat = lat
-      @lng = lng
-      @additional_properties = additional_properties
-      @_field_set = { "lat": lat, "lng": lng }
-    end
-
-    # Deserialize a JSON object to an instance of InboundLocationMessageCoordinates
-    #
-    # @param json_object [String]
-    # @return [Pinnacle::InboundLocationMessageCoordinates]
-    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 InboundLocationMessageCoordinates 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/inbound_media_message.rb

@@ -1,112 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "media_payload"
-require_relative "inbound_message_metadata"
-require "ostruct"
-require "json"
-
-module Pinnacle
-  class InboundMediaMessage
-    # @return [String]
-    attr_reader :message_type
-    # @return [String]
-    attr_reader :text
-    # @return [Array<Pinnacle::MediaPayload>]
-    attr_reader :media_urls
-    # @return [String]
-    attr_reader :from
-    # @return [String]
-    attr_reader :to
-    # @return [Pinnacle::InboundMessageMetadata]
-    attr_reader :metadata
-    # @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_type [String]
-    # @param text [String]
-    # @param media_urls [Array<Pinnacle::MediaPayload>]
-    # @param from [String]
-    # @param to [String]
-    # @param metadata [Pinnacle::InboundMessageMetadata]
-    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-    # @return [Pinnacle::InboundMediaMessage]
-    def initialize(media_urls:, from:, to:, message_type: OMIT, text: OMIT, metadata: OMIT, additional_properties: nil)
-      @message_type = message_type if message_type != OMIT
-      @text = text if text != OMIT
-      @media_urls = media_urls
-      @from = from
-      @to = to
-      @metadata = metadata if metadata != OMIT
-      @additional_properties = additional_properties
-      @_field_set = {
-        "messageType": message_type,
-        "text": text,
-        "mediaUrls": media_urls,
-        "from": from,
-        "to": to,
-        "metadata": metadata
-      }.reject do |_k, v|
-        v == OMIT
-      end
-    end
-
-    # Deserialize a JSON object to an instance of InboundMediaMessage
-    #
-    # @param json_object [String]
-    # @return [Pinnacle::InboundMediaMessage]
-    def self.from_json(json_object:)
-      struct = JSON.parse(json_object, object_class: OpenStruct)
-      parsed_json = JSON.parse(json_object)
-      message_type = parsed_json["messageType"]
-      text = parsed_json["text"]
-      media_urls = parsed_json["mediaUrls"]&.map do |item|
-        item = item.to_json
-        Pinnacle::MediaPayload.from_json(json_object: item)
-      end
-      from = parsed_json["from"]
-      to = parsed_json["to"]
-      if parsed_json["metadata"].nil?
-        metadata = nil
-      else
-        metadata = parsed_json["metadata"].to_json
-        metadata = Pinnacle::InboundMessageMetadata.from_json(json_object: metadata)
-      end
-      new(
-        message_type: message_type,
-        text: text,
-        media_urls: media_urls,
-        from: from,
-        to: to,
-        metadata: metadata,
-        additional_properties: struct
-      )
-    end
-
-    # Serialize an instance of InboundMediaMessage 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_type&.is_a?(String) != false || raise("Passed value for field obj.message_type is not the expected type, validation failed.")
-      obj.text&.is_a?(String) != false || raise("Passed value for field obj.text is not the expected type, validation failed.")
-      obj.media_urls.is_a?(Array) != false || raise("Passed value for field obj.media_urls is not the expected type, validation failed.")
-      obj.from.is_a?(String) != false || raise("Passed value for field obj.from is not the expected type, validation failed.")
-      obj.to.is_a?(String) != false || raise("Passed value for field obj.to is not the expected type, validation failed.")
-      obj.metadata.nil? || Pinnacle::InboundMessageMetadata.validate_raw(obj: obj.metadata)
-    end
-  end
-end

data/lib/rcs/types/inbound_message.rb

@@ -1,88 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "inbound_message_message_type"
-require_relative "inbound_message_metadata"
-require "ostruct"
-require "json"
-
-module Pinnacle
-  class InboundMessage
-    # @return [String]
-    attr_reader :from
-    # @return [String]
-    attr_reader :to
-    # @return [Pinnacle::InboundMessageMessageType]
-    attr_reader :message_type
-    # @return [Pinnacle::InboundMessageMetadata]
-    attr_reader :metadata
-    # @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]
-    # @param to [String]
-    # @param message_type [Pinnacle::InboundMessageMessageType]
-    # @param metadata [Pinnacle::InboundMessageMetadata]
-    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-    # @return [Pinnacle::InboundMessage]
-    def initialize(from:, to:, message_type:, metadata: OMIT, additional_properties: nil)
-      @from = from
-      @to = to
-      @message_type = message_type
-      @metadata = metadata if metadata != OMIT
-      @additional_properties = additional_properties
-      @_field_set = { "from": from, "to": to, "messageType": message_type, "metadata": metadata }.reject do |_k, v|
-        v == OMIT
-      end
-    end
-
-    # Deserialize a JSON object to an instance of InboundMessage
-    #
-    # @param json_object [String]
-    # @return [Pinnacle::InboundMessage]
-    def self.from_json(json_object:)
-      struct = JSON.parse(json_object, object_class: OpenStruct)
-      parsed_json = JSON.parse(json_object)
-      from = parsed_json["from"]
-      to = parsed_json["to"]
-      message_type = parsed_json["messageType"]
-      if parsed_json["metadata"].nil?
-        metadata = nil
-      else
-        metadata = parsed_json["metadata"].to_json
-        metadata = Pinnacle::InboundMessageMetadata.from_json(json_object: metadata)
-      end
-      new(
-        from: from,
-        to: to,
-        message_type: message_type,
-        metadata: metadata,
-        additional_properties: struct
-      )
-    end
-
-    # Serialize an instance of InboundMessage 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.to.is_a?(String) != false || raise("Passed value for field obj.to is not the expected type, validation failed.")
-      obj.message_type.is_a?(Pinnacle::InboundMessageMessageType) != false || raise("Passed value for field obj.message_type is not the expected type, validation failed.")
-      obj.metadata.nil? || Pinnacle::InboundMessageMetadata.validate_raw(obj: obj.metadata)
-    end
-  end
-end

data/lib/rcs/types/inbound_message_message_type.rb

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-module Pinnacle
-  class InboundMessageMessageType
-    TEXT = "text"
-    MEDIA = "media"
-    ACTION = "action"
-    LOCATION = "location"
-  end
-end