tremendous_ruby 5.5.0 → 5.7.0

data/lib/tremendous/models/create_report_request.rb

@@ -0,0 +1,295 @@
+=begin
+#API Endpoints
+
+#Deliver monetary rewards and incentives to employees, customers, survey participants, and more through the Tremendous API. For organizational tasks, like managing your organization and it's members within Tremendous, please see the Tremendous Organizational API.
+
+The version of the OpenAPI document: 2
+Contact: developers@tremendous.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.8.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Tremendous
+  class CreateReportRequest
+    # Type of report for retrieval. <table> <thead> <tr> <th>Report type</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>digital_rewards</code></td> <td>Report for Tremendous digital reward history</td> </tr> </tbody> </table>
+    attr_accessor :report_type
+
+    # Format the report will be generated in. <table> <thead> <tr> <th>Format</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>csv</code></td> <td>CSV format for report</td> </tr> </tbody> </table>
+    attr_accessor :format
+
+    attr_accessor :filters
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'report_type' => :'report_type',
+        :'format' => :'format',
+        :'filters' => :'filters'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'report_type' => :'String',
+        :'format' => :'String',
+        :'filters' => :'CreateReportRequestFilters'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'filters'
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Tremendous::CreateReportRequest` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Tremendous::CreateReportRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'report_type')
+        self.report_type = attributes[:'report_type']
+      else
+        self.report_type = nil
+      end
+
+      if attributes.key?(:'format')
+        self.format = attributes[:'format']
+      else
+        self.format = nil
+      end
+
+      if attributes.key?(:'filters')
+        self.filters = attributes[:'filters']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @report_type.nil?
+        invalid_properties.push('invalid value for "report_type", report_type cannot be nil.')
+      end
+
+      if @format.nil?
+        invalid_properties.push('invalid value for "format", format cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @report_type.nil?
+      report_type_validator = EnumAttributeValidator.new('String', ["digital_rewards"])
+      return false unless report_type_validator.valid?(@report_type)
+      return false if @format.nil?
+      format_validator = EnumAttributeValidator.new('String', ["csv"])
+      return false unless format_validator.valid?(@format)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] report_type Object to be assigned
+    def report_type=(report_type)
+      validator = EnumAttributeValidator.new('String', ["digital_rewards"])
+      unless validator.valid?(report_type)
+        fail ArgumentError, "invalid value for \"report_type\", must be one of #{validator.allowable_values}."
+      end
+      @report_type = report_type
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] format Object to be assigned
+    def format=(format)
+      validator = EnumAttributeValidator.new('String', ["csv"])
+      unless validator.valid?(format)
+        fail ArgumentError, "invalid value for \"format\", must be one of #{validator.allowable_values}."
+      end
+      @format = format
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          report_type == o.report_type &&
+          format == o.format &&
+          filters == o.filters
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [report_type, format, filters].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = Tremendous.const_get(type)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end

data/lib/tremendous/models/{create_public_key200_response.rb → create_report_request_filters.rb}

@@ -14,13 +14,14 @@ require 'date'
 require 'time'
 
 module Tremendous
-  class CreatePublicKey200Response
-    attr_accessor :public_key
+  # Filters to apply to the report. Corresponds to the filters provided in the dashboard 
+  class CreateReportRequestFilters
+    attr_accessor :digital_rewards
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'public_key' => :'public_key'
+        :'digital_rewards' => :'digital_rewards'
       }
     end
 
@@ -32,13 +33,14 @@ module Tremendous
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'public_key' => :'PublicKeysResponsePublicKeysInner'
+        :'digital_rewards' => :'CreateReportRequestFiltersDigitalRewards'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'digital_rewards'
       ])
     end
 
@@ -46,21 +48,19 @@ module Tremendous
     # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
       if (!attributes.is_a?(Hash))
-        fail ArgumentError, "The input argument (attributes) must be a hash in `Tremendous::CreatePublicKey200Response` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Tremendous::CreateReportRequestFilters` initialize method"
       end
 
       # check to see if the attribute exists and convert string to symbol for hash key
       attributes = attributes.each_with_object({}) { |(k, v), h|
         if (!self.class.attribute_map.key?(k.to_sym))
-          fail ArgumentError, "`#{k}` is not a valid attribute in `Tremendous::CreatePublicKey200Response`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Tremendous::CreateReportRequestFilters`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'public_key')
-        self.public_key = attributes[:'public_key']
-      else
-        self.public_key = nil
+      if attributes.key?(:'digital_rewards')
+        self.digital_rewards = attributes[:'digital_rewards']
       end
     end
 
@@ -69,10 +69,6 @@ module Tremendous
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
-      if @public_key.nil?
-        invalid_properties.push('invalid value for "public_key", public_key cannot be nil.')
-      end
-
       invalid_properties
     end
 
@@ -80,7 +76,6 @@ module Tremendous
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      return false if @public_key.nil?
       true
     end
 
@@ -89,7 +84,7 @@ module Tremendous
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          public_key == o.public_key
+          digital_rewards == o.digital_rewards
     end
 
     # @see the `==` method
@@ -101,7 +96,7 @@ module Tremendous
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [public_key].hash
+      [digital_rewards].hash
     end
 
     # Builds the object from hash

data/lib/tremendous/models/{create_invoice.rb → create_report_request_filters_digital_rewards.rb}

@@ -14,22 +14,63 @@ require 'date'
 require 'time'
 
 module Tremendous
-  class CreateInvoice
-    # Reference to the purchase order number within your organization
-    attr_accessor :po_number
-
-    # Amount of the invoice in USD
+  # Filters object for a `report_type: digital_rewards` report 
+  class CreateReportRequestFiltersDigitalRewards
     attr_accessor :amount
 
-    # A note to be included in the invoice. This is for your internal use and will not be visible to the recipient. 
-    attr_accessor :memo
+    # ID of the Tremendous campaign that this report should be limited to 
+    attr_accessor :campaign_id
+
+    attr_accessor :created_at
+
+    # Delivery date for gifts that should be returned in the report 
+    attr_accessor :delivered_at
+
+    # Delivery method for rewards returned in the report 
+    attr_accessor :delivery_method
+
+    # ID of the Tremendous order that this report should be limited to 
+    attr_accessor :order_id
+
+    # Order status for rewards returned in the report 
+    attr_accessor :order_status
+
+    # Status for rewards returned in the report 
+    attr_accessor :status
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'po_number' => :'po_number',
         :'amount' => :'amount',
-        :'memo' => :'memo'
+        :'campaign_id' => :'campaign_id',
+        :'created_at' => :'created_at',
+        :'delivered_at' => :'delivered_at',
+        :'delivery_method' => :'delivery_method',
+        :'order_id' => :'order_id',
+        :'order_status' => :'order_status',
+        :'status' => :'status'
       }
     end
 
@@ -41,17 +82,28 @@ module Tremendous
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'po_number' => :'String',
-        :'amount' => :'Float',
-        :'memo' => :'String'
+        :'amount' => :'CreateReportRequestFiltersDigitalRewardsAmount',
+        :'campaign_id' => :'String',
+        :'created_at' => :'CreateReportRequestFiltersDigitalRewardsCreatedAt',
+        :'delivered_at' => :'Date',
+        :'delivery_method' => :'String',
+        :'order_id' => :'String',
+        :'order_status' => :'String',
+        :'status' => :'Array<String>'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'po_number',
-        :'memo'
+        :'amount',
+        :'campaign_id',
+        :'created_at',
+        :'delivered_at',
+        :'delivery_method',
+        :'order_id',
+        :'order_status',
+        :'status'
       ])
     end
 
@@ -59,29 +111,49 @@ module Tremendous
     # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
       if (!attributes.is_a?(Hash))
-        fail ArgumentError, "The input argument (attributes) must be a hash in `Tremendous::CreateInvoice` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Tremendous::CreateReportRequestFiltersDigitalRewards` initialize method"
       end
 
       # check to see if the attribute exists and convert string to symbol for hash key
       attributes = attributes.each_with_object({}) { |(k, v), h|
         if (!self.class.attribute_map.key?(k.to_sym))
-          fail ArgumentError, "`#{k}` is not a valid attribute in `Tremendous::CreateInvoice`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Tremendous::CreateReportRequestFiltersDigitalRewards`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'po_number')
-        self.po_number = attributes[:'po_number']
-      end
-
       if attributes.key?(:'amount')
         self.amount = attributes[:'amount']
-      else
-        self.amount = nil
       end
 
-      if attributes.key?(:'memo')
-        self.memo = attributes[:'memo']
+      if attributes.key?(:'campaign_id')
+        self.campaign_id = attributes[:'campaign_id']
+      end
+
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      end
+
+      if attributes.key?(:'delivered_at')
+        self.delivered_at = attributes[:'delivered_at']
+      end
+
+      if attributes.key?(:'delivery_method')
+        self.delivery_method = attributes[:'delivery_method']
+      end
+
+      if attributes.key?(:'order_id')
+        self.order_id = attributes[:'order_id']
+      end
+
+      if attributes.key?(:'order_status')
+        self.order_status = attributes[:'order_status']
+      end
+
+      if attributes.key?(:'status')
+        if (value = attributes[:'status']).is_a?(Array)
+          self.status = value
+        end
       end
     end
 
@@ -90,10 +162,6 @@ module Tremendous
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
-      if @amount.nil?
-        invalid_properties.push('invalid value for "amount", amount cannot be nil.')
-      end
-
       invalid_properties
     end
 
@@ -101,18 +169,46 @@ module Tremendous
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      return false if @amount.nil?
+      delivery_method_validator = EnumAttributeValidator.new('String', ["phone", "email", "link", "mail", "direct"])
+      return false unless delivery_method_validator.valid?(@delivery_method)
+      order_status_validator = EnumAttributeValidator.new('String', ["executed", "canceled", "failed", "pending_approval"])
+      return false unless order_status_validator.valid?(@order_status)
       true
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] delivery_method Object to be assigned
+    def delivery_method=(delivery_method)
+      validator = EnumAttributeValidator.new('String', ["phone", "email", "link", "mail", "direct"])
+      unless validator.valid?(delivery_method)
+        fail ArgumentError, "invalid value for \"delivery_method\", must be one of #{validator.allowable_values}."
+      end
+      @delivery_method = delivery_method
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] order_status Object to be assigned
+    def order_status=(order_status)
+      validator = EnumAttributeValidator.new('String', ["executed", "canceled", "failed", "pending_approval"])
+      unless validator.valid?(order_status)
+        fail ArgumentError, "invalid value for \"order_status\", must be one of #{validator.allowable_values}."
+      end
+      @order_status = order_status
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          po_number == o.po_number &&
           amount == o.amount &&
-          memo == o.memo
+          campaign_id == o.campaign_id &&
+          created_at == o.created_at &&
+          delivered_at == o.delivered_at &&
+          delivery_method == o.delivery_method &&
+          order_id == o.order_id &&
+          order_status == o.order_status &&
+          status == o.status
     end
 
     # @see the `==` method
@@ -124,7 +220,7 @@ module Tremendous
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [po_number, amount, memo].hash
+      [amount, campaign_id, created_at, delivered_at, delivery_method, order_id, order_status, status].hash
     end
 
     # Builds the object from hash