tremendous_ruby 5.4.0 → 5.6.0

data/lib/tremendous/models/order_with_link_rewards_inner.rb

@@ -0,0 +1,385 @@
+=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
+  # A single reward, sent to a recipient. A reward is always part of an order.  Either `products` or `campaign_id` must be specified. 
+  class OrderWithLinkRewardsInner
+    # Tremendous ID of the reward
+    attr_accessor :id
+
+    # Tremendous ID of the order this reward is part of.
+    attr_accessor :order_id
+
+    # Date the reward was created
+    attr_accessor :created_at
+
+    # ID of the campaign in your account, that defines the available products (different gift cards, charity, etc.) that the recipient can choose from. 
+    attr_accessor :campaign_id
+
+    # List of IDs of product (different gift cards, charity, etc.) that will be available to the recipient to choose from.  Providing a `products` array will override the products made available by the campaign specified using the `campaign_id` property unless the `products` array is empty. It will _not_ override other campaign attributes, like the message and customization of the look and feel. 
+    attr_accessor :products
+
+    attr_accessor :value
+
+    attr_accessor :recipient
+
+    # Timestamp of reward delivery within the next year. Note that if date-time is provided, the time values will be ignored.
+    attr_accessor :deliver_at
+
+    attr_accessor :custom_fields
+
+    attr_accessor :delivery
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'order_id' => :'order_id',
+        :'created_at' => :'created_at',
+        :'campaign_id' => :'campaign_id',
+        :'products' => :'products',
+        :'value' => :'value',
+        :'recipient' => :'recipient',
+        :'deliver_at' => :'deliver_at',
+        :'custom_fields' => :'custom_fields',
+        :'delivery' => :'delivery'
+      }
+    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
+      {
+        :'id' => :'String',
+        :'order_id' => :'String',
+        :'created_at' => :'Time',
+        :'campaign_id' => :'String',
+        :'products' => :'Array<String>',
+        :'value' => :'ListRewards200ResponseRewardsInnerValue',
+        :'recipient' => :'ListRewards200ResponseRewardsInnerRecipient',
+        :'deliver_at' => :'Date',
+        :'custom_fields' => :'Array<RewardBaseCustomFieldsInner>',
+        :'delivery' => :'RewardWithLinkDelivery'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'campaign_id',
+      ])
+    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::OrderWithLinkRewardsInner` 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::OrderWithLinkRewardsInner`. 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?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'order_id')
+        self.order_id = attributes[:'order_id']
+      end
+
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      end
+
+      if attributes.key?(:'campaign_id')
+        self.campaign_id = attributes[:'campaign_id']
+      end
+
+      if attributes.key?(:'products')
+        if (value = attributes[:'products']).is_a?(Array)
+          self.products = value
+        end
+      end
+
+      if attributes.key?(:'value')
+        self.value = attributes[:'value']
+      end
+
+      if attributes.key?(:'recipient')
+        self.recipient = attributes[:'recipient']
+      end
+
+      if attributes.key?(:'deliver_at')
+        self.deliver_at = attributes[:'deliver_at']
+      end
+
+      if attributes.key?(:'custom_fields')
+        if (value = attributes[:'custom_fields']).is_a?(Array)
+          self.custom_fields = value
+        end
+      end
+
+      if attributes.key?(:'delivery')
+        self.delivery = attributes[:'delivery']
+      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
+      pattern = Regexp.new(/[A-Z0-9]{4,20}/)
+      if !@id.nil? && @id !~ pattern
+        invalid_properties.push("invalid value for \"id\", must conform to the pattern #{pattern}.")
+      end
+
+      pattern = Regexp.new(/[A-Z0-9]{4,20}/)
+      if !@order_id.nil? && @order_id !~ pattern
+        invalid_properties.push("invalid value for \"order_id\", must conform to the pattern #{pattern}.")
+      end
+
+      pattern = Regexp.new(/[A-Z0-9]{4,20}/)
+      if !@campaign_id.nil? && @campaign_id !~ pattern
+        invalid_properties.push("invalid value for \"campaign_id\", must conform to the pattern #{pattern}.")
+      end
+
+      if !@products.nil? && @products.length < 1
+        invalid_properties.push('invalid value for "products", number of items must be greater than or equal to 1.')
+      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 !@id.nil? && @id !~ Regexp.new(/[A-Z0-9]{4,20}/)
+      return false if !@order_id.nil? && @order_id !~ Regexp.new(/[A-Z0-9]{4,20}/)
+      return false if !@campaign_id.nil? && @campaign_id !~ Regexp.new(/[A-Z0-9]{4,20}/)
+      return false if !@products.nil? && @products.length < 1
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] id Value to be assigned
+    def id=(id)
+      if id.nil?
+        fail ArgumentError, 'id cannot be nil'
+      end
+
+      pattern = Regexp.new(/[A-Z0-9]{4,20}/)
+      if id !~ pattern
+        fail ArgumentError, "invalid value for \"id\", must conform to the pattern #{pattern}."
+      end
+
+      @id = id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] order_id Value to be assigned
+    def order_id=(order_id)
+      if order_id.nil?
+        fail ArgumentError, 'order_id cannot be nil'
+      end
+
+      pattern = Regexp.new(/[A-Z0-9]{4,20}/)
+      if order_id !~ pattern
+        fail ArgumentError, "invalid value for \"order_id\", must conform to the pattern #{pattern}."
+      end
+
+      @order_id = order_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] campaign_id Value to be assigned
+    def campaign_id=(campaign_id)
+      pattern = Regexp.new(/[A-Z0-9]{4,20}/)
+      if !campaign_id.nil? && campaign_id !~ pattern
+        fail ArgumentError, "invalid value for \"campaign_id\", must conform to the pattern #{pattern}."
+      end
+
+      @campaign_id = campaign_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] products Value to be assigned
+    def products=(products)
+      if products.nil?
+        fail ArgumentError, 'products cannot be nil'
+      end
+
+      if products.length < 1
+        fail ArgumentError, 'invalid value for "products", number of items must be greater than or equal to 1.'
+      end
+
+      @products = products
+    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 &&
+          id == o.id &&
+          order_id == o.order_id &&
+          created_at == o.created_at &&
+          campaign_id == o.campaign_id &&
+          products == o.products &&
+          value == o.value &&
+          recipient == o.recipient &&
+          deliver_at == o.deliver_at &&
+          custom_fields == o.custom_fields &&
+          delivery == o.delivery
+    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
+      [id, order_id, created_at, campaign_id, products, value, recipient, deliver_at, custom_fields, delivery].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/order_without_link.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 2
 Contact: developers@tremendous.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 7.3.0
+Generator version: 7.8.0
 
 =end
 
@@ -31,12 +31,15 @@ module Tremendous
     # Execution status of a given order  <table>   <thead>     <tr>       <th>         Status       </th>       <th>         Description       </th>     </tr>   </thead>   <tbody>     <tr>       <td>         <code>           CANCELED         </code>       </td>       <td>         The order and all of its rewards were canceled.       </td>     </tr>     <tr>       <td>         <code>           CART         </code>       </td>       <td>         The order has been created, but hasn't yet been processed.       </td>     </tr>     <tr>       <td>         <code>           EXECUTED         </code>       </td>       <td>         The order has been executed. Payment has been handled and rewards are being delivered (if applicable).       </td>     </tr>     <tr>       <td>         <code>           FAILED         </code>       </td>       <td>         The order could not be processed due to an error. E.g. due to insufficient funds in the account.       </td>     </tr>     <tr>       <td>         <code>           PENDING APPROVAL         </code>       </td>       <td>         The order has been created but needs approval to be executed.       </td>     </tr>     <tr>       <td>         <code>           PENDING INTERNAL PAYMENT APPROVAL         </code>       </td>       <td>         The order has been created but it is under review and requires approval from our team.       </td>     </tr>    </tbody> </table> 
     attr_accessor :status
 
+    # Name of the channel in which the order was created
+    attr_accessor :channel
+
     attr_accessor :payment
 
     # The ID for the invoice associated with this order
     attr_accessor :invoice_id
 
-    attr_accessor :reward
+    attr_accessor :rewards
 
     class EnumAttributeValidator
       attr_reader :datatype
@@ -68,9 +71,10 @@ module Tremendous
         :'campaign_id' => :'campaign_id',
         :'created_at' => :'created_at',
         :'status' => :'status',
+        :'channel' => :'channel',
         :'payment' => :'payment',
         :'invoice_id' => :'invoice_id',
-        :'reward' => :'reward'
+        :'rewards' => :'rewards'
       }
     end
 
@@ -87,9 +91,10 @@ module Tremendous
         :'campaign_id' => :'String',
         :'created_at' => :'Time',
         :'status' => :'String',
+        :'channel' => :'String',
         :'payment' => :'OrderBasePayment',
         :'invoice_id' => :'String',
-        :'reward' => :'OrderWithoutLinkReward'
+        :'rewards' => :'Array<OrderWithoutLinkRewardsInner>'
       }
     end
 
@@ -142,6 +147,10 @@ module Tremendous
         self.status = nil
       end
 
+      if attributes.key?(:'channel')
+        self.channel = attributes[:'channel']
+      end
+
       if attributes.key?(:'payment')
         self.payment = attributes[:'payment']
       end
@@ -150,8 +159,10 @@ module Tremendous
         self.invoice_id = attributes[:'invoice_id']
       end
 
-      if attributes.key?(:'reward')
-        self.reward = attributes[:'reward']
+      if attributes.key?(:'rewards')
+        if (value = attributes[:'rewards']).is_a?(Array)
+          self.rewards = value
+        end
       end
     end
 
@@ -196,6 +207,8 @@ module Tremendous
       return false if @status.nil?
       status_validator = EnumAttributeValidator.new('String', ["CANCELED", "CART", "EXECUTED", "FAILED", "PENDING APPROVAL", "PENDING INTERNAL PAYMENT APPROVAL"])
       return false unless status_validator.valid?(@status)
+      channel_validator = EnumAttributeValidator.new('String', ["UI", "API", "EMBED", "DECIPHER", "QUALTRICS", "TYPEFORM", "SURVEY MONKEY"])
+      return false unless channel_validator.valid?(@channel)
       true
     end
 
@@ -235,6 +248,16 @@ module Tremendous
       @status = status
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] channel Object to be assigned
+    def channel=(channel)
+      validator = EnumAttributeValidator.new('String', ["UI", "API", "EMBED", "DECIPHER", "QUALTRICS", "TYPEFORM", "SURVEY MONKEY"])
+      unless validator.valid?(channel)
+        fail ArgumentError, "invalid value for \"channel\", must be one of #{validator.allowable_values}."
+      end
+      @channel = channel
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -245,9 +268,10 @@ module Tremendous
           campaign_id == o.campaign_id &&
           created_at == o.created_at &&
           status == o.status &&
+          channel == o.channel &&
           payment == o.payment &&
           invoice_id == o.invoice_id &&
-          reward == o.reward
+          rewards == o.rewards
     end
 
     # @see the `==` method
@@ -259,7 +283,7 @@ module Tremendous
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, external_id, campaign_id, created_at, status, payment, invoice_id, reward].hash
+      [id, external_id, campaign_id, created_at, status, channel, payment, invoice_id, rewards].hash
     end
 
     # Builds the object from hash

data/lib/tremendous/models/{order_without_link_reward.rb → order_without_link_rewards_inner.rb}

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 2
 Contact: developers@tremendous.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 7.3.0
+Generator version: 7.8.0
 
 =end
 
@@ -15,7 +15,7 @@ require 'time'
 
 module Tremendous
   # A single reward, sent to a recipient. A reward is always part of an order.  Either `products` or `campaign_id` must be specified. 
-  class OrderWithoutLinkReward
+  class OrderWithoutLinkRewardsInner
     # Tremendous ID of the reward
     attr_accessor :id
 
@@ -90,13 +90,13 @@ 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::OrderWithoutLinkReward` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Tremendous::OrderWithoutLinkRewardsInner` 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::OrderWithoutLinkReward`. 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::OrderWithoutLinkRewardsInner`. 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
       }

data/lib/tremendous/models/organization.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 2
 Contact: developers@tremendous.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 7.3.0
+Generator version: 7.8.0
 
 =end
 

data/lib/tremendous/models/payment_details.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 2
 Contact: developers@tremendous.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 7.3.0
+Generator version: 7.8.0
 
 =end
 
@@ -26,39 +26,13 @@ module Tremendous
 
     attr_accessor :refund
 
-    # Name of the channel in which the order was created
-    attr_accessor :channel
-
-    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
       {
         :'subtotal' => :'subtotal',
         :'total' => :'total',
         :'fees' => :'fees',
-        :'refund' => :'refund',
-        :'channel' => :'channel'
+        :'refund' => :'refund'
       }
     end
 
@@ -73,8 +47,7 @@ module Tremendous
         :'subtotal' => :'Float',
         :'total' => :'Float',
         :'fees' => :'Float',
-        :'refund' => :'PaymentDetailsRefund',
-        :'channel' => :'String'
+        :'refund' => :'PaymentDetailsRefund'
       }
     end
 
@@ -114,10 +87,6 @@ module Tremendous
       if attributes.key?(:'refund')
         self.refund = attributes[:'refund']
       end
-
-      if attributes.key?(:'channel')
-        self.channel = attributes[:'channel']
-      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -147,8 +116,6 @@ module Tremendous
       return false if !@subtotal.nil? && @subtotal < 0
       return false if !@total.nil? && @total < 0
       return false if !@fees.nil? && @fees < 0
-      channel_validator = EnumAttributeValidator.new('String', ["UI", "API", "EMBED", "DECIPHER", "QUALTRICS", "TYPEFORM", "SURVEY MONKEY"])
-      return false unless channel_validator.valid?(@channel)
       true
     end
 
@@ -194,16 +161,6 @@ module Tremendous
       @fees = fees
     end
 
-    # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] channel Object to be assigned
-    def channel=(channel)
-      validator = EnumAttributeValidator.new('String', ["UI", "API", "EMBED", "DECIPHER", "QUALTRICS", "TYPEFORM", "SURVEY MONKEY"])
-      unless validator.valid?(channel)
-        fail ArgumentError, "invalid value for \"channel\", must be one of #{validator.allowable_values}."
-      end
-      @channel = channel
-    end
-
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -212,8 +169,7 @@ module Tremendous
           subtotal == o.subtotal &&
           total == o.total &&
           fees == o.fees &&
-          refund == o.refund &&
-          channel == o.channel
+          refund == o.refund
     end
 
     # @see the `==` method
@@ -225,7 +181,7 @@ module Tremendous
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [subtotal, total, fees, refund, channel].hash
+      [subtotal, total, fees, refund].hash
     end
 
     # Builds the object from hash

data/lib/tremendous/models/payment_details_refund.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 2
 Contact: developers@tremendous.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 7.3.0
+Generator version: 7.8.0
 
 =end