tremendous_ruby 5.12.0 → 5.14.0

data/lib/tremendous/models/list_fraud_reviews200_response_fraud_reviews_inner_geo.rb

@@ -0,0 +1,242 @@
+=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.12.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Tremendous
+  # The Geo location, based on the recipient's IP.
+  class ListFraudReviews200ResponseFraudReviewsInnerGeo
+    # The recipient's IP.
+    attr_accessor :ip
+
+    # The country code (ISO-3166 alpha-2 character code) linked to the recipient's IP.
+    attr_accessor :country
+
+    # The city associated with the recipient's IP.
+    attr_accessor :city
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'ip' => :'ip',
+        :'country' => :'country',
+        :'city' => :'city'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'ip' => :'String',
+        :'country' => :'String',
+        :'city' => :'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::ListFraudReviews200ResponseFraudReviewsInnerGeo` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Tremendous::ListFraudReviews200ResponseFraudReviewsInnerGeo`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'ip')
+        self.ip = attributes[:'ip']
+      end
+
+      if attributes.key?(:'country')
+        self.country = attributes[:'country']
+      end
+
+      if attributes.key?(:'city')
+        self.city = attributes[:'city']
+      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 &&
+          ip == o.ip &&
+          country == o.country &&
+          city == o.city
+    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
+      [ip, country, city].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_funding_sources200_response_funding_sources_inner.rb

@@ -24,7 +24,7 @@ module Tremendous
     # Indicates which actions this funding source can perform.   <table>     <thead>       <tr>         <th>Permission</th>         <th>Description</th>         </tr>     </thead>     <tbody>       <tr>         <td><code>api_orders</code></td>         <td>Usable for orders via API.</td>       </tr>       <tr>         <td><code>dashboard_orders</code></td>         <td>Usable for orders via Tremendous dashboard.</td>       </tr>       <tr>         <td><code>balance_funding</code></td>         <td>Usable to add funds to a balance (via dashboard or API).</td>       </tr>     </tbody>   </table> 
     attr_accessor :usage_permissions
 
-    # Status of the funding_source    <table>     <thead>       <tr>         <th>Status</th>         <th>Description</th>         </tr>     </thead>     <tbody>       <tr>         <td><code>active</code></td>         <td>Ready for use.</td>       </tr>       <tr>         <td><code>deleted</code></td>         <td>Manually removed, and not usable.</td>       </tr>       <tr>         <td><code>pending_confirmation</code></td>         <td>Awaiting verification of ownership.</td>       </tr>       <tr>         <td><code>failed</code></td>         <td>Last payment attempt failed, and not usable (contact Tremendous support to reinstate).</td>       </tr>     </tbody>   </table> 
+    # Status of the funding_source    <table>     <thead>       <tr>         <th>Status</th>         <th>Description</th>         </tr>     </thead>     <tbody>       <tr>         <td><code>active</code></td>         <td>Ready for use.</td>       </tr>       <tr>         <td><code>deleted</code></td>         <td>Manually removed, and not usable.</td>       </tr>       <tr>         <td><code>failed</code></td>         <td>Last payment attempt failed, and not usable (contact Tremendous support to reinstate).</td>       </tr>     </tbody>   </table> 
     attr_accessor :status
 
     # **Only available when `method` is set to `invoice`.** 
@@ -177,7 +177,7 @@ module Tremendous
       return false if @method.nil?
       method_validator = EnumAttributeValidator.new('String', ["balance", "bank_account", "credit_card", "invoice"])
       return false unless method_validator.valid?(@method)
-      status_validator = EnumAttributeValidator.new('String', ["active", "deleted", "pending_confirmation", "failed"])
+      status_validator = EnumAttributeValidator.new('String', ["active", "deleted", "failed"])
       return false unless status_validator.valid?(@status)
       type_validator = EnumAttributeValidator.new('String', ["COMMERCIAL", "PRO_FORMA", "PREFUNDING_ONLY"])
       return false unless type_validator.valid?(@type)
@@ -213,7 +213,7 @@ module Tremendous
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] status Object to be assigned
     def status=(status)
-      validator = EnumAttributeValidator.new('String', ["active", "deleted", "pending_confirmation", "failed"])
+      validator = EnumAttributeValidator.new('String', ["active", "deleted", "failed"])
       unless validator.valid?(status)
         fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
       end

data/lib/tremendous/models/list_funding_sources200_response_funding_sources_inner_meta.rb

@@ -15,10 +15,10 @@ require 'time'
 
 module Tremendous
   class ListFundingSources200ResponseFundingSourcesInnerMeta
-    # **Only exists for balance and commercial invoicing.**  For balance: available amount (in cents USD) For commercial invoicing: available credit amount calculated as (credit limit - outstanding balance) (in cents USD) 
+    # **Only exists for balance and commercial invoicing.**  For balance: available amount (in cents USD) For commercial invoicing: available credit amount calculated as (credit limit - outstanding balance) (in cents USD)  *Caution: In the \"list funding sources\" endpoint this value is cached and may not be up to date. Use the \"get funding source\" endpoint to get the most up to date value.* 
     attr_accessor :available_cents
 
-    # **Only available when `method` is set to `balance`.**  Funds that are already registered on your Tremendous account but which have not yet been deposited in your account (e.g. unpaid invoices) (in Cents USD). 
+    # **Only available when `method` is set to `balance`.**  Funds that are already registered on your Tremendous account but which have not yet been deposited in your account (e.g. payments that need to be manually reviewed by our ops team) (in Cents USD). 
     attr_accessor :pending_cents
 
     # **Only exists for commercial invoicing.**  Available credit limit (in cents USD) 
@@ -207,6 +207,11 @@ module Tremendous
         :'day_of_week',
         :'address_1',
         :'address_2',
+        :'city',
+        :'state',
+        :'zip',
+        :'phone',
+        :'emails',
         :'failure_details'
       ])
     end

data/lib/tremendous/models/list_invoices200_response_invoices_inner.rb

@@ -22,9 +22,12 @@ module Tremendous
     # Reference to the purchase order number within your organization
     attr_accessor :po_number
 
-    # Amount of the invoice in USD
+    # Amount of the invoice
     attr_accessor :amount
 
+    # Currency of the invoice
+    attr_accessor :currency
+
     attr_accessor :international
 
     # Status of this invoice  <table>   <thead>     <tr>       <th>Status</th>       <th>Description</th>     </tr>   </thead>   <tbody>     <tr>       <td><code>DELETED</code></td>       <td>Invoice has been deleted by your organization</td>     </tr>     <tr>       <td><code>PAID</code></td>       <td>Invoice has been paid by your organization</td>     </tr>     <tr>       <td><code>OPEN</code></td>       <td>Invoice has been created by your organization but has not been paid, yet</td>     </tr>   </tbody> </table> 
@@ -70,6 +73,7 @@ module Tremendous
         :'id' => :'id',
         :'po_number' => :'po_number',
         :'amount' => :'amount',
+        :'currency' => :'currency',
         :'international' => :'international',
         :'status' => :'status',
         :'orders' => :'orders',
@@ -95,6 +99,7 @@ module Tremendous
         :'id' => :'String',
         :'po_number' => :'String',
         :'amount' => :'Float',
+        :'currency' => :'String',
         :'international' => :'Boolean',
         :'status' => :'String',
         :'orders' => :'Array<String>',
@@ -144,6 +149,12 @@ module Tremendous
         self.amount = nil
       end
 
+      if attributes.key?(:'currency')
+        self.currency = attributes[:'currency']
+      else
+        self.currency = 'USD'
+      end
+
       if attributes.key?(:'international')
         self.international = attributes[:'international']
       end
@@ -209,6 +220,8 @@ module Tremendous
       warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if @id.nil?
       return false if @amount.nil?
+      currency_validator = EnumAttributeValidator.new('String', ["USD", "EUR", "GBP"])
+      return false unless currency_validator.valid?(@currency)
       return false if @status.nil?
       status_validator = EnumAttributeValidator.new('String', ["DELETED", "PAID", "OPEN", "MARKED_AS_PAID"])
       return false unless status_validator.valid?(@status)
@@ -236,6 +249,16 @@ module Tremendous
       @amount = amount
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] currency Object to be assigned
+    def currency=(currency)
+      validator = EnumAttributeValidator.new('String', ["USD", "EUR", "GBP"])
+      unless validator.valid?(currency)
+        fail ArgumentError, "invalid value for \"currency\", must be one of #{validator.allowable_values}."
+      end
+      @currency = currency
+    end
+
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] status Object to be assigned
     def status=(status)
@@ -264,6 +287,7 @@ module Tremendous
           id == o.id &&
           po_number == o.po_number &&
           amount == o.amount &&
+          currency == o.currency &&
           international == o.international &&
           status == o.status &&
           orders == o.orders &&
@@ -281,7 +305,7 @@ module Tremendous
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, po_number, amount, international, status, orders, rewards, created_at, paid_at].hash
+      [id, po_number, amount, currency, international, status, orders, rewards, created_at, paid_at].hash
     end
 
     # Builds the object from hash

data/lib/tremendous/models/list_products_response_products_inner.rb

@@ -24,9 +24,12 @@ 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>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>     <tr>       <td><code>cash_app</code></td>       <td>Payout via Cash App</td>     </tr>   </tbody> </table> 
+    # The category of the 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>     <tr>       <td><code>cash_app</code></td>       <td>Payout via Cash App</td>     </tr>   </tbody> </table> 
     attr_accessor :category
 
+    # Additional classification for the product. Only applicable to products with a `category` of `merchant_card`. Possible subcategories:  * `beauty_and_health` * `digital_financial_services` * `electronics` * `entertainment` * `fashion` * `food_and_drink` * `general_merchandise` * `grocery_and_supermarkets` * `home_and_living` * `mobility_and_fuel` * `sports_and_outdoor_gear` * `travel_and_hospitality` 
+    attr_accessor :subcategory
+
     # Legal disclosures for this product. Can be in HTML format.
     attr_accessor :disclosure
 
@@ -76,6 +79,7 @@ module Tremendous
         :'name' => :'name',
         :'description' => :'description',
         :'category' => :'category',
+        :'subcategory' => :'subcategory',
         :'disclosure' => :'disclosure',
         :'skus' => :'skus',
         :'currency_codes' => :'currency_codes',
@@ -103,6 +107,7 @@ module Tremendous
         :'name' => :'String',
         :'description' => :'String',
         :'category' => :'String',
+        :'subcategory' => :'String',
         :'disclosure' => :'String',
         :'skus' => :'Array<ListProductsResponseProductsInnerSkusInner>',
         :'currency_codes' => :'Array<String>',
@@ -160,6 +165,10 @@ module Tremendous
         self.category = nil
       end
 
+      if attributes.key?(:'subcategory')
+        self.subcategory = attributes[:'subcategory']
+      end
+
       if attributes.key?(:'disclosure')
         self.disclosure = attributes[:'disclosure']
       else
@@ -273,6 +282,8 @@ module Tremendous
       return false if @category.nil?
       category_validator = EnumAttributeValidator.new('String', ["ach", "charity", "instant_debit_transfer", "merchant_card", "paypal", "venmo", "visa_card", "cash_app"])
       return false unless category_validator.valid?(@category)
+      subcategory_validator = EnumAttributeValidator.new('String', ["beauty_and_health", "digital_financial_services", "electronics", "entertainment", "fashion", "food_and_drink", "general_merchandise", "grocery_and_supermarkets", "home_and_living", "mobility_and_fuel", "sports_and_outdoor_gear", "travel_and_hospitality"])
+      return false unless subcategory_validator.valid?(@subcategory)
       return false if @disclosure.nil?
       return false if @currency_codes.nil?
       return false if @currency_codes.length < 1
@@ -328,6 +339,16 @@ module Tremendous
       @category = category
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] subcategory Object to be assigned
+    def subcategory=(subcategory)
+      validator = EnumAttributeValidator.new('String', ["beauty_and_health", "digital_financial_services", "electronics", "entertainment", "fashion", "food_and_drink", "general_merchandise", "grocery_and_supermarkets", "home_and_living", "mobility_and_fuel", "sports_and_outdoor_gear", "travel_and_hospitality"])
+      unless validator.valid?(subcategory)
+        fail ArgumentError, "invalid value for \"subcategory\", must be one of #{validator.allowable_values}."
+      end
+      @subcategory = subcategory
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] disclosure Value to be assigned
     def disclosure=(disclosure)
@@ -375,6 +396,7 @@ module Tremendous
           name == o.name &&
           description == o.description &&
           category == o.category &&
+          subcategory == o.subcategory &&
           disclosure == o.disclosure &&
           skus == o.skus &&
           currency_codes == o.currency_codes &&
@@ -393,7 +415,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, usage_instructions, documents].hash
+      [id, name, description, category, subcategory, disclosure, skus, currency_codes, countries, images, usage_instructions, documents].hash
     end
 
     # Builds the object from hash

data/lib/tremendous/models/list_rewards200_response_rewards_inner_custom_fields_inner.rb

@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module Tremendous
-  # Reward custom data for searching, tracking or copy (see [Adding custom fields to orders](https://developers.tremendous.com/reference/using-custom-fields-to-add-custom-data-to-rewards).)
+  # Reward custom data for searching, tracking or copy (see [Adding custom fields to orders](https://developers.tremendous.com/docs/using-custom-fields-to-add-custom-data-to-rewards).)
   class ListRewards200ResponseRewardsInnerCustomFieldsInner
     # Tremendous ID of the custom field
     attr_accessor :id