tremendous_ruby 5.9.0 → 5.10.0

data/lib/tremendous/models/list_products_response_products_inner.rb

@@ -24,7 +24,7 @@ module Tremendous
     # Detailed description of the product. Mostly used for products with a `category` of `charities`.
     attr_accessor :description
 
-    # The category of this product  <table>   <thead>     <tr>       <th>Category</th>       <th>Description</th>     </tr>   </thead>   <tbody>     <tr>       <td><code>ach</code></td>       <td>Bank transfer to the recipient</td>     </tr>     <tr>       <td><code>charity</code></td>       <td>Donations to a charity</td>     </tr>     <tr>       <td><code>merchant_card</code></td>       <td>A gift card for a certain merchant (e.g. Amazon)</td>     </tr>     <tr>       <td><code>paypal</code></td>       <td>Payout via PayPal</td>     </tr>     <tr>       <td><code>venmo</code></td>       <td>Payout via Venmo</td>     </tr>     <tr>       <td><code>visa_card</code></td>       <td>Payout in form of a Visa debit card</td>     </tr>   </tbody> </table> 
+    # The category of this product  <table>   <thead>     <tr>       <th>Category</th>       <th>Description</th>     </tr>   </thead>   <tbody>     <tr>       <td><code>ach</code></td>       <td>Bank transfer to the recipient</td>     </tr>     <tr>       <td><code>charity</code></td>       <td>Donations to a charity</td>     </tr>     <tr>       <td><code>instant_debit_transfer</code></td>       <td>Instant debit transfer to the recipient</td>     </tr>     <tr>       <td><code>merchant_card</code></td>       <td>A gift card for a certain merchant (e.g. Amazon)</td>     </tr>     <tr>       <td><code>paypal</code></td>       <td>Payout via PayPal</td>     </tr>     <tr>       <td><code>venmo</code></td>       <td>Payout via Venmo</td>     </tr>     <tr>       <td><code>visa_card</code></td>       <td>Payout in form of a Visa debit card</td>     </tr>   </tbody> </table> 
     attr_accessor :category
 
     # Legal disclosures for this product. Can be in HTML format.
@@ -42,6 +42,11 @@ module Tremendous
     # List of product images associated with this product (e.g. logos or images of the gift cards)
     attr_accessor :images
 
+    # Instructions for how to use the product, if applicable. Mostly used for products with a `category` of `merchant_card`.
+    attr_accessor :usage_instructions
+
+    attr_accessor :documents
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -75,7 +80,9 @@ module Tremendous
         :'skus' => :'skus',
         :'currency_codes' => :'currency_codes',
         :'countries' => :'countries',
-        :'images' => :'images'
+        :'images' => :'images',
+        :'usage_instructions' => :'usage_instructions',
+        :'documents' => :'documents'
       }
     end
 
@@ -95,13 +102,16 @@ module Tremendous
         :'skus' => :'Array<ListProductsResponseProductsInnerSkusInner>',
         :'currency_codes' => :'Array<String>',
         :'countries' => :'Array<ListProductsResponseProductsInnerCountriesInner>',
-        :'images' => :'Array<ListProductsResponseProductsInnerImagesInner>'
+        :'images' => :'Array<ListProductsResponseProductsInnerImagesInner>',
+        :'usage_instructions' => :'String',
+        :'documents' => :'ListProductsResponseProductsInnerDocuments'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'documents'
       ])
     end
 
@@ -179,6 +189,14 @@ module Tremendous
       else
         self.images = nil
       end
+
+      if attributes.key?(:'usage_instructions')
+        self.usage_instructions = attributes[:'usage_instructions']
+      end
+
+      if attributes.key?(:'documents')
+        self.documents = attributes[:'documents']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -247,7 +265,7 @@ module Tremendous
       return false if @name.nil?
       return false if @description.nil?
       return false if @category.nil?
-      category_validator = EnumAttributeValidator.new('String', ["ach", "charity", "merchant_card", "paypal", "venmo", "visa_card"])
+      category_validator = EnumAttributeValidator.new('String', ["ach", "charity", "instant_debit_transfer", "merchant_card", "paypal", "venmo", "visa_card"])
       return false unless category_validator.valid?(@category)
       return false if @disclosure.nil?
       return false if @currency_codes.nil?
@@ -277,7 +295,7 @@ module Tremendous
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] category Object to be assigned
     def category=(category)
-      validator = EnumAttributeValidator.new('String', ["ach", "charity", "merchant_card", "paypal", "venmo", "visa_card"])
+      validator = EnumAttributeValidator.new('String', ["ach", "charity", "instant_debit_transfer", "merchant_card", "paypal", "venmo", "visa_card"])
       unless validator.valid?(category)
         fail ArgumentError, "invalid value for \"category\", must be one of #{validator.allowable_values}."
       end
@@ -325,7 +343,9 @@ module Tremendous
           skus == o.skus &&
           currency_codes == o.currency_codes &&
           countries == o.countries &&
-          images == o.images
+          images == o.images &&
+          usage_instructions == o.usage_instructions &&
+          documents == o.documents
     end
 
     # @see the `==` method
@@ -337,7 +357,7 @@ module Tremendous
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, name, description, category, disclosure, skus, currency_codes, countries, images].hash
+      [id, name, description, category, disclosure, skus, currency_codes, countries, images, usage_instructions, documents].hash
     end
 
     # Builds the object from hash

data/lib/tremendous/models/list_products_response_products_inner_documents.rb

@@ -0,0 +1,236 @@
+=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 its 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
+  # URLs and files related to product documentation. 
+  class ListProductsResponseProductsInnerDocuments
+    # URL to the cardholder agreement PDF file.
+    attr_accessor :cardholder_agreement_pdf
+
+    # URL to the cardholder agreement web page.
+    attr_accessor :cardholder_agreement_url
+
+    # URL to the privacy policy web page.
+    attr_accessor :privacy_policy_url
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'cardholder_agreement_pdf' => :'cardholder_agreement_pdf',
+        :'cardholder_agreement_url' => :'cardholder_agreement_url',
+        :'privacy_policy_url' => :'privacy_policy_url'
+      }
+    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
+      {
+        :'cardholder_agreement_pdf' => :'String',
+        :'cardholder_agreement_url' => :'String',
+        :'privacy_policy_url' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    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::ListProductsResponseProductsInnerDocuments` 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::ListProductsResponseProductsInnerDocuments`. 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?(:'cardholder_agreement_pdf')
+        self.cardholder_agreement_pdf = attributes[:'cardholder_agreement_pdf']
+      end
+
+      if attributes.key?(:'cardholder_agreement_url')
+        self.cardholder_agreement_url = attributes[:'cardholder_agreement_url']
+      end
+
+      if attributes.key?(:'privacy_policy_url')
+        self.privacy_policy_url = attributes[:'privacy_policy_url']
+      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
+      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'
+      true
+    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 &&
+          cardholder_agreement_pdf == o.cardholder_agreement_pdf &&
+          cardholder_agreement_url == o.cardholder_agreement_url &&
+          privacy_policy_url == o.privacy_policy_url
+    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
+      [cardholder_agreement_pdf, cardholder_agreement_url, privacy_policy_url].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/list_products_response_products_inner_images_inner.rb

@@ -21,6 +21,9 @@ module Tremendous
     # Type of image
     attr_accessor :type
 
+    # The MIME content type of this image
+    attr_accessor :content_type
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -47,7 +50,8 @@ module Tremendous
     def self.attribute_map
       {
         :'src' => :'src',
-        :'type' => :'type'
+        :'type' => :'type',
+        :'content_type' => :'content_type'
       }
     end
 
@@ -60,13 +64,15 @@ module Tremendous
     def self.openapi_types
       {
         :'src' => :'String',
-        :'type' => :'String'
+        :'type' => :'String',
+        :'content_type' => :'String'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'content_type'
       ])
     end
 
@@ -96,6 +102,10 @@ module Tremendous
       else
         self.type = nil
       end
+
+      if attributes.key?(:'content_type')
+        self.content_type = attributes[:'content_type']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -141,7 +151,8 @@ module Tremendous
       return true if self.equal?(o)
       self.class == o.class &&
           src == o.src &&
-          type == o.type
+          type == o.type &&
+          content_type == o.content_type
     end
 
     # @see the `==` method
@@ -153,7 +164,7 @@ module Tremendous
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [src, type].hash
+      [src, type, content_type].hash
     end
 
     # Builds the object from hash

data/lib/tremendous/models/list_rewards200_response_rewards_inner_delivery.rb

@@ -19,7 +19,7 @@ module Tremendous
     # How to deliver the reward to the recipient.  <table>   <thead>     <tr>       <th>Delivery Method</th>       <th>Description</th>     </tr>   </thead>   <tbody>     <tr>       <td><code>EMAIL</code></td>       <td>Deliver the reward to the recipient by email</td>     </tr>     <tr>       <td><code>LINK</code></td>       <td>         <p>Deliver the reward to the recipient via a link.</p>         <p>The link can be retrieved on a successfully ordered reward via the <code>/rewards</code> or <code>/rewards/{id}</code> endpoint. That link must then be  delivered to the recipient out-of-band.</p>       </td>     </tr>     <tr>       <td><code>PHONE</code></td>       <td>Deliver the reward to the recipient by SMS</td>     </tr>   </tbody> </table> 
     attr_accessor :method
 
-    # Current status of the delivery of the reward:  * `SCHEDULED` - Reward is scheduled for delivery and will be delivered soon. * `FAILED` - Delivery of reward failed (e.g. email bounced). * `SUCCEEDED` - Reward was successfully delivered (email or text message delivered or reward link opened). * `PENDING` - Delivery is pending but not yet scheduled. 
+    # Current status of the delivery of the reward:  * `SCHEDULED` - Reward is scheduled for delivery and will be delivered soon. * `FAILED` - Delivery of reward failed (e.g. email bounced). * `SUCCEEDED` - Reward was successfully delivered (email or text message delivered or reward link active). * `PENDING` - Delivery is pending but not yet scheduled. 
     attr_accessor :status
 
     class EnumAttributeValidator

data/lib/tremendous/models/product.rb

@@ -24,7 +24,7 @@ module Tremendous
     # Detailed description of the product. Mostly used for products with a `category` of `charities`.
     attr_accessor :description
 
-    # The category of this product  <table>   <thead>     <tr>       <th>Category</th>       <th>Description</th>     </tr>   </thead>   <tbody>     <tr>       <td><code>ach</code></td>       <td>Bank transfer to the recipient</td>     </tr>     <tr>       <td><code>charity</code></td>       <td>Donations to a charity</td>     </tr>     <tr>       <td><code>merchant_card</code></td>       <td>A gift card for a certain merchant (e.g. Amazon)</td>     </tr>     <tr>       <td><code>paypal</code></td>       <td>Payout via PayPal</td>     </tr>     <tr>       <td><code>venmo</code></td>       <td>Payout via Venmo</td>     </tr>     <tr>       <td><code>visa_card</code></td>       <td>Payout in form of a Visa debit card</td>     </tr>   </tbody> </table> 
+    # The category of this product  <table>   <thead>     <tr>       <th>Category</th>       <th>Description</th>     </tr>   </thead>   <tbody>     <tr>       <td><code>ach</code></td>       <td>Bank transfer to the recipient</td>     </tr>     <tr>       <td><code>charity</code></td>       <td>Donations to a charity</td>     </tr>     <tr>       <td><code>instant_debit_transfer</code></td>       <td>Instant debit transfer to the recipient</td>     </tr>     <tr>       <td><code>merchant_card</code></td>       <td>A gift card for a certain merchant (e.g. Amazon)</td>     </tr>     <tr>       <td><code>paypal</code></td>       <td>Payout via PayPal</td>     </tr>     <tr>       <td><code>venmo</code></td>       <td>Payout via Venmo</td>     </tr>     <tr>       <td><code>visa_card</code></td>       <td>Payout in form of a Visa debit card</td>     </tr>   </tbody> </table> 
     attr_accessor :category
 
     # Legal disclosures for this product. Can be in HTML format.
@@ -42,6 +42,11 @@ module Tremendous
     # List of product images associated with this product (e.g. logos or images of the gift cards)
     attr_accessor :images
 
+    # Instructions for how to use the product, if applicable. Mostly used for products with a `category` of `merchant_card`.
+    attr_accessor :usage_instructions
+
+    attr_accessor :documents
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -75,7 +80,9 @@ module Tremendous
         :'skus' => :'skus',
         :'currency_codes' => :'currency_codes',
         :'countries' => :'countries',
-        :'images' => :'images'
+        :'images' => :'images',
+        :'usage_instructions' => :'usage_instructions',
+        :'documents' => :'documents'
       }
     end
 
@@ -95,13 +102,16 @@ module Tremendous
         :'skus' => :'Array<ListProductsResponseProductsInnerSkusInner>',
         :'currency_codes' => :'Array<String>',
         :'countries' => :'Array<ListProductsResponseProductsInnerCountriesInner>',
-        :'images' => :'Array<ListProductsResponseProductsInnerImagesInner>'
+        :'images' => :'Array<ListProductsResponseProductsInnerImagesInner>',
+        :'usage_instructions' => :'String',
+        :'documents' => :'ListProductsResponseProductsInnerDocuments'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'documents'
       ])
     end
 
@@ -179,6 +189,14 @@ module Tremendous
       else
         self.images = nil
       end
+
+      if attributes.key?(:'usage_instructions')
+        self.usage_instructions = attributes[:'usage_instructions']
+      end
+
+      if attributes.key?(:'documents')
+        self.documents = attributes[:'documents']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -247,7 +265,7 @@ module Tremendous
       return false if @name.nil?
       return false if @description.nil?
       return false if @category.nil?
-      category_validator = EnumAttributeValidator.new('String', ["ach", "charity", "merchant_card", "paypal", "venmo", "visa_card"])
+      category_validator = EnumAttributeValidator.new('String', ["ach", "charity", "instant_debit_transfer", "merchant_card", "paypal", "venmo", "visa_card"])
       return false unless category_validator.valid?(@category)
       return false if @disclosure.nil?
       return false if @currency_codes.nil?
@@ -277,7 +295,7 @@ module Tremendous
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] category Object to be assigned
     def category=(category)
-      validator = EnumAttributeValidator.new('String', ["ach", "charity", "merchant_card", "paypal", "venmo", "visa_card"])
+      validator = EnumAttributeValidator.new('String', ["ach", "charity", "instant_debit_transfer", "merchant_card", "paypal", "venmo", "visa_card"])
       unless validator.valid?(category)
         fail ArgumentError, "invalid value for \"category\", must be one of #{validator.allowable_values}."
       end
@@ -325,7 +343,9 @@ module Tremendous
           skus == o.skus &&
           currency_codes == o.currency_codes &&
           countries == o.countries &&
-          images == o.images
+          images == o.images &&
+          usage_instructions == o.usage_instructions &&
+          documents == o.documents
     end
 
     # @see the `==` method
@@ -337,7 +357,7 @@ module Tremendous
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, name, description, category, disclosure, skus, currency_codes, countries, images].hash
+      [id, name, description, category, disclosure, skus, currency_codes, countries, images, usage_instructions, documents].hash
     end
 
     # Builds the object from hash