tremendous_ruby 5.21.0 → 5.22.0

data/lib/tremendous/models/list_campaigns200_response_campaigns_inner.rb

@@ -27,10 +27,35 @@ module Tremendous
     # List of IDs of products (different gift cards, charity, etc.) that are available in this campaign. 
     attr_accessor :products
 
+    # Determines whether fees for premium products are added to the order total (`SENDER`) or deducted from the recipient's reward amount (`RECIPIENT`). Campaigns with `RECIPIENT` must include at least one fee-free product. 
+    attr_accessor :fee_charged_to
+
     attr_accessor :webpage_style
 
     attr_accessor :email_style
 
+    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
       {
@@ -38,6 +63,7 @@ module Tremendous
         :'name' => :'name',
         :'description' => :'description',
         :'products' => :'products',
+        :'fee_charged_to' => :'fee_charged_to',
         :'webpage_style' => :'webpage_style',
         :'email_style' => :'email_style'
       }
@@ -60,6 +86,7 @@ module Tremendous
         :'name' => :'String',
         :'description' => :'String',
         :'products' => :'Array<String>',
+        :'fee_charged_to' => :'String',
         :'webpage_style' => :'ListCampaigns200ResponseCampaignsInnerWebpageStyle',
         :'email_style' => :'ListCampaigns200ResponseCampaignsInnerEmailStyle'
       }
@@ -69,6 +96,7 @@ module Tremendous
     def self.openapi_nullable
       Set.new([
         :'description',
+        :'fee_charged_to',
       ])
     end
 
@@ -112,6 +140,10 @@ module Tremendous
         self.products = nil
       end
 
+      if attributes.key?(:'fee_charged_to')
+        self.fee_charged_to = attributes[:'fee_charged_to']
+      end
+
       if attributes.key?(:'webpage_style')
         self.webpage_style = attributes[:'webpage_style']
       end
@@ -149,6 +181,8 @@ module Tremendous
       return false if !@id.nil? && @id !~ Regexp.new(/[A-Z0-9]{4,20}/)
       return false if @name.nil?
       return false if @products.nil?
+      fee_charged_to_validator = EnumAttributeValidator.new('String', ["SENDER", "RECIPIENT"])
+      return false unless fee_charged_to_validator.valid?(@fee_charged_to)
       true
     end
 
@@ -187,6 +221,16 @@ module Tremendous
       @products = products
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] fee_charged_to Object to be assigned
+    def fee_charged_to=(fee_charged_to)
+      validator = EnumAttributeValidator.new('String', ["SENDER", "RECIPIENT"])
+      unless validator.valid?(fee_charged_to)
+        fail ArgumentError, "invalid value for \"fee_charged_to\", must be one of #{validator.allowable_values}."
+      end
+      @fee_charged_to = fee_charged_to
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -196,6 +240,7 @@ module Tremendous
           name == o.name &&
           description == o.description &&
           products == o.products &&
+          fee_charged_to == o.fee_charged_to &&
           webpage_style == o.webpage_style &&
           email_style == o.email_style
     end
@@ -209,7 +254,7 @@ module Tremendous
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, name, description, products, webpage_style, email_style].hash
+      [id, name, description, products, fee_charged_to, webpage_style, email_style].hash
     end
 
     # Builds the object from hash

data/lib/tremendous/models/list_connected_organizations200_response_connected_organizations_inner_organization.rb

@@ -24,6 +24,9 @@ module Tremendous
     # URL of the website of that organization
     attr_accessor :website
 
+    # Currency used for this organization's balances, orders, and transactions.
+    attr_accessor :currency_code
+
     # Status of the organization. Organizations need to be approved to be able to use them to send out rewards.
     attr_accessor :status
 
@@ -58,6 +61,7 @@ module Tremendous
         :'id' => :'id',
         :'name' => :'name',
         :'website' => :'website',
+        :'currency_code' => :'currency_code',
         :'status' => :'status',
         :'created_at' => :'created_at'
       }
@@ -79,6 +83,7 @@ module Tremendous
         :'id' => :'String',
         :'name' => :'String',
         :'website' => :'String',
+        :'currency_code' => :'String',
         :'status' => :'String',
         :'created_at' => :'Date'
       }
@@ -122,6 +127,10 @@ module Tremendous
         self.website = nil
       end
 
+      if attributes.key?(:'currency_code')
+        self.currency_code = attributes[:'currency_code']
+      end
+
       if attributes.key?(:'status')
         self.status = attributes[:'status']
       end
@@ -217,6 +226,7 @@ module Tremendous
           id == o.id &&
           name == o.name &&
           website == o.website &&
+          currency_code == o.currency_code &&
           status == o.status &&
           created_at == o.created_at
     end
@@ -230,7 +240,7 @@ module Tremendous
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, name, website, status, created_at].hash
+      [id, name, website, currency_code, status, created_at].hash
     end
 
     # Builds the object from hash

data/lib/tremendous/models/list_fraud_rules200_response_fraud_rules_inner.rb

@@ -16,7 +16,7 @@ require 'time'
 module Tremendous
   # An active fraud rule
   class ListFraudRules200ResponseFraudRulesInner
-    # * `review_country` - Flags when the recipient's IP country matches the criteria in the rule * `review_ip` - Flags when recipient's IP matches one in the list * `review_email` - Flags when the recipient's email matches one in the list * `review_redeemed_rewards_count` - Flags when the recipient redeemed more than the number of rewards specified in the config * `review_redeemed_rewards_amount` - Flags when the recipient redeemed more than the total amount specified in the config * `review_multiple_emails` - Flags when recipient's device or account has multiple emails associated * `review_vpn` - Flags when VPN is suspected * `review_tremendous_flag_list` - Flags rewards when redemption attributes match at least one criteria defined by the Tremendous flag list * `review_previously_blocked_recipients` - Flags rewards when the recipient has been blocked before * `allow_ip` - Releases a reward when a recipient's IP matches one in the list * `allow_email` - Releases a reward when the recipient's email matches one in the list 
+    # * `review_country` - Flags when the recipient's IP country matches the criteria in the rule * `review_ip` - Flags when recipient's IP matches one in the list * `review_email` - Flags when the recipient's email matches one in the list * `review_redeemed_rewards_count` - Flags when the recipient redeemed more than the number of rewards specified in the config * `review_redeemed_rewards_amount` - Flags when the recipient redeemed more than the total amount specified in the config. The amount is denominated in the organization's currency. * `review_multiple_emails` - Flags when recipient's device or account has multiple emails associated * `review_vpn` - Flags when VPN is suspected * `review_tremendous_flag_list` - Flags rewards when redemption attributes match at least one criteria defined by the Tremendous flag list * `review_previously_blocked_recipients` - Flags rewards when the recipient has been blocked before * `allow_ip` - Releases a reward when a recipient's IP matches one in the list * `allow_email` - Releases a reward when the recipient's email matches one in the list 
     attr_accessor :rule_type
 
     # The configuration associated with the rule. The properties allowed depend on the type of rule. This property is only present for rules that require configuration. 

data/lib/tremendous/models/list_funding_sources200_response_funding_sources_inner_meta.rb

@@ -15,13 +15,25 @@ 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)  *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.* 
+    # **Only exists for balance and commercial invoicing.**  For balance: available amount denominated in `currency_code`. For commercial invoicing: available credit amount denominated in `currency_code`, calculated as (credit limit - outstanding balance).  *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_amount
+
+    # Same as `available_amount`, but in cents.
     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. payments that need to be manually reviewed by our ops team) (in Cents USD). 
+    # **Only exists for balance and commercial invoicing.**  The currency of the balance or credit amounts (e.g. `available_amount`, `pending_amount`, `credit_limit_amount`).  Always matches the organization's currency. 
+    attr_accessor :currency_code
+
+    # **Only available when `method` is set to `balance`.**  Funds registered on your Tremendous account but not yet deposited in your account (e.g. payments that need to be manually reviewed by our ops team). Denominated in `currency_code`. 
+    attr_accessor :pending_amount
+
+    # Same as `pending_amount`, but in cents.
     attr_accessor :pending_cents
 
-    # **Only exists for commercial invoicing.**  Available credit limit (in cents USD) 
+    # **Only exists for commercial invoicing.**  Available credit limit denominated in `currency_code`. 
+    attr_accessor :credit_limit_amount
+
+    # Same as `credit_limit_amount`, but in cents.
     attr_accessor :credit_limit_cents
 
     # **Only available when `method` is set to `bank_account` or `credit_card`.**  Name of the holder of the bank account or credit_card 
@@ -123,8 +135,12 @@ module Tremendous
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'available_amount' => :'available_amount',
         :'available_cents' => :'available_cents',
+        :'currency_code' => :'currency_code',
+        :'pending_amount' => :'pending_amount',
         :'pending_cents' => :'pending_cents',
+        :'credit_limit_amount' => :'credit_limit_amount',
         :'credit_limit_cents' => :'credit_limit_cents',
         :'accountholder_name' => :'accountholder_name',
         :'account_type' => :'account_type',
@@ -167,8 +183,12 @@ module Tremendous
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'available_amount' => :'Float',
         :'available_cents' => :'Integer',
+        :'currency_code' => :'String',
+        :'pending_amount' => :'Float',
         :'pending_cents' => :'Integer',
+        :'credit_limit_amount' => :'Float',
         :'credit_limit_cents' => :'Integer',
         :'accountholder_name' => :'String',
         :'account_type' => :'String',
@@ -232,14 +252,30 @@ module Tremendous
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'available_amount')
+        self.available_amount = attributes[:'available_amount']
+      end
+
       if attributes.key?(:'available_cents')
         self.available_cents = attributes[:'available_cents']
       end
 
+      if attributes.key?(:'currency_code')
+        self.currency_code = attributes[:'currency_code']
+      end
+
+      if attributes.key?(:'pending_amount')
+        self.pending_amount = attributes[:'pending_amount']
+      end
+
       if attributes.key?(:'pending_cents')
         self.pending_cents = attributes[:'pending_cents']
       end
 
+      if attributes.key?(:'credit_limit_amount')
+        self.credit_limit_amount = attributes[:'credit_limit_amount']
+      end
+
       if attributes.key?(:'credit_limit_cents')
         self.credit_limit_cents = attributes[:'credit_limit_cents']
       end
@@ -452,8 +488,12 @@ module Tremendous
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          available_amount == o.available_amount &&
           available_cents == o.available_cents &&
+          currency_code == o.currency_code &&
+          pending_amount == o.pending_amount &&
           pending_cents == o.pending_cents &&
+          credit_limit_amount == o.credit_limit_amount &&
           credit_limit_cents == o.credit_limit_cents &&
           accountholder_name == o.accountholder_name &&
           account_type == o.account_type &&
@@ -491,7 +531,7 @@ module Tremendous
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [available_cents, pending_cents, credit_limit_cents, accountholder_name, account_type, bank_name, account_number_mask, account_routing_mask, refundable, network, last4, expired, year, month, last_payment_failed_at, invoice_type, interval, day_of_week, net, company_name, address_1, address_2, city, state, zip, phone, emails, failure_details].hash
+      [available_amount, available_cents, currency_code, pending_amount, pending_cents, credit_limit_amount, credit_limit_cents, accountholder_name, account_type, bank_name, account_number_mask, account_routing_mask, refundable, network, last4, expired, year, month, last_payment_failed_at, invoice_type, interval, day_of_week, net, company_name, address_1, address_2, city, state, zip, phone, emails, failure_details].hash
     end
 
     # Builds the object from hash

data/lib/tremendous/models/list_orders200_response_orders_inner.rb

@@ -25,7 +25,7 @@ module Tremendous
     # 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
 
-    # Date the order has been created
+    # Date the order was created
     attr_accessor :created_at
 
     # 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>           OPEN         </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>     <tr>       <td>         <code>           PENDING SETTLEMENT         </code>       </td>       <td>         The order has been created but the funds are being held until the settlement window clears.       </td>     </tr>    </tbody> </table> 

data/lib/tremendous/models/list_orders200_response_orders_inner_payment.rb

@@ -14,20 +14,23 @@ require 'date'
 require 'time'
 
 module Tremendous
-  # Cost breakdown of the order (cost of rewards + fees). Cost and fees are always denominated in USD, independent from the currency of the ordered rewards. Note that this property will only appear for processed orders (`status` is `EXECUTED`).
+  # Cost breakdown of the order (cost of rewards + fees). Cost and fees are denominated in the organization's currency (see payment `currency_code`), independent of the ordered rewards' currency. Note that this property will only appear for processed orders (`status` is `EXECUTED`).
   class ListOrders200ResponseOrdersInnerPayment
-    # Total price of the order before fees (in USD)
+    # Total price of the order before fees, denominated in `currency_code`.
     attr_accessor :subtotal
 
-    # Total price of the order including fees (in USD)
+    # Total price of the order including fees, denominated in `currency_code`.
     attr_accessor :total
 
-    # Fees for the order (in USD)
+    # Fees for the order, denominated in `currency_code`.
     attr_accessor :fees
 
-    # Discount for the order (in USD)
+    # Discount for the order, denominated in `currency_code`.
     attr_accessor :discount
 
+    # Currency in which the payment amounts (subtotal, total, fees, discount, refund) are denominated.  This always matches the organization's currency. 
+    attr_accessor :currency_code
+
     attr_accessor :refund
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -37,6 +40,7 @@ module Tremendous
         :'total' => :'total',
         :'fees' => :'fees',
         :'discount' => :'discount',
+        :'currency_code' => :'currency_code',
         :'refund' => :'refund'
       }
     end
@@ -58,6 +62,7 @@ module Tremendous
         :'total' => :'Float',
         :'fees' => :'Float',
         :'discount' => :'Float',
+        :'currency_code' => :'String',
         :'refund' => :'ListOrders200ResponseOrdersInnerPaymentRefund'
       }
     end
@@ -108,6 +113,12 @@ module Tremendous
         self.discount = nil
       end
 
+      if attributes.key?(:'currency_code')
+        self.currency_code = attributes[:'currency_code']
+      else
+        self.currency_code = nil
+      end
+
       if attributes.key?(:'refund')
         self.refund = attributes[:'refund']
       end
@@ -150,6 +161,10 @@ module Tremendous
         invalid_properties.push('invalid value for "discount", must be greater than or equal to 0.')
       end
 
+      if @currency_code.nil?
+        invalid_properties.push('invalid value for "currency_code", currency_code cannot be nil.')
+      end
+
       invalid_properties
     end
 
@@ -165,6 +180,7 @@ module Tremendous
       return false if @fees < 0
       return false if @discount.nil?
       return false if @discount < 0
+      return false if @currency_code.nil?
       true
     end
 
@@ -224,6 +240,16 @@ module Tremendous
       @discount = discount
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] currency_code Value to be assigned
+    def currency_code=(currency_code)
+      if currency_code.nil?
+        fail ArgumentError, 'currency_code cannot be nil'
+      end
+
+      @currency_code = currency_code
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -233,6 +259,7 @@ module Tremendous
           total == o.total &&
           fees == o.fees &&
           discount == o.discount &&
+          currency_code == o.currency_code &&
           refund == o.refund
     end
 
@@ -245,7 +272,7 @@ module Tremendous
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [subtotal, total, fees, discount, refund].hash
+      [subtotal, total, fees, discount, currency_code, refund].hash
     end
 
     # Builds the object from hash

data/lib/tremendous/models/list_orders200_response_orders_inner_payment_refund.rb

@@ -14,15 +14,19 @@ require 'date'
 require 'time'
 
 module Tremendous
-  # Breakdown of the order refunds (total amount in USD, independent from the currency of the ordered rewards). Note that this property will only appear for canceled orders or orders with canceled rewards. 
+  # Breakdown of the order refunds (total denominated in `currency_code`, independent of the ordered rewards' currency). Note that this property will only appear for canceled orders or orders with canceled rewards. 
   class ListOrders200ResponseOrdersInnerPaymentRefund
-    # Total amount of the order refunds (in USD)
+    # Total amount of the order refunds, denominated in `currency_code`.
     attr_accessor :total
 
+    # Currency of the refund. Always matches the organization's currency.
+    attr_accessor :currency_code
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'total' => :'total'
+        :'total' => :'total',
+        :'currency_code' => :'currency_code'
       }
     end
 
@@ -39,7 +43,8 @@ module Tremendous
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'total' => :'Float'
+        :'total' => :'Float',
+        :'currency_code' => :'String'
       }
     end
 
@@ -70,6 +75,12 @@ module Tremendous
       else
         self.total = nil
       end
+
+      if attributes.key?(:'currency_code')
+        self.currency_code = attributes[:'currency_code']
+      else
+        self.currency_code = nil
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -85,6 +96,10 @@ module Tremendous
         invalid_properties.push('invalid value for "total", must be greater than or equal to 0.')
       end
 
+      if @currency_code.nil?
+        invalid_properties.push('invalid value for "currency_code", currency_code cannot be nil.')
+      end
+
       invalid_properties
     end
 
@@ -94,6 +109,7 @@ module Tremendous
       warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if @total.nil?
       return false if @total < 0
+      return false if @currency_code.nil?
       true
     end
 
@@ -111,12 +127,23 @@ module Tremendous
       @total = total
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] currency_code Value to be assigned
+    def currency_code=(currency_code)
+      if currency_code.nil?
+        fail ArgumentError, 'currency_code cannot be nil'
+      end
+
+      @currency_code = currency_code
+    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 &&
-          total == o.total
+          total == o.total &&
+          currency_code == o.currency_code
     end
 
     # @see the `==` method
@@ -128,7 +155,7 @@ module Tremendous
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [total].hash
+      [total, currency_code].hash
     end
 
     # Builds the object from hash

data/lib/tremendous/models/list_organizations200_response_organizations_inner.rb

@@ -24,6 +24,9 @@ module Tremendous
     # URL of the website of that organization
     attr_accessor :website
 
+    # Currency used for this organization's balances, orders, and transactions.
+    attr_accessor :currency_code
+
     # Status of the organization. Organizations need to be approved to be able to use them to send out rewards.
     attr_accessor :status
 
@@ -58,6 +61,7 @@ module Tremendous
         :'id' => :'id',
         :'name' => :'name',
         :'website' => :'website',
+        :'currency_code' => :'currency_code',
         :'status' => :'status',
         :'created_at' => :'created_at'
       }
@@ -79,6 +83,7 @@ module Tremendous
         :'id' => :'String',
         :'name' => :'String',
         :'website' => :'String',
+        :'currency_code' => :'String',
         :'status' => :'String',
         :'created_at' => :'Date'
       }
@@ -122,6 +127,10 @@ module Tremendous
         self.website = nil
       end
 
+      if attributes.key?(:'currency_code')
+        self.currency_code = attributes[:'currency_code']
+      end
+
       if attributes.key?(:'status')
         self.status = attributes[:'status']
       end
@@ -217,6 +226,7 @@ module Tremendous
           id == o.id &&
           name == o.name &&
           website == o.website &&
+          currency_code == o.currency_code &&
           status == o.status &&
           created_at == o.created_at
     end
@@ -230,7 +240,7 @@ module Tremendous
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, name, website, status, created_at].hash
+      [id, name, website, currency_code, status, created_at].hash
     end
 
     # Builds the object from hash

data/lib/tremendous/models/list_rewards200_response_rewards_inner_recipient.rb

@@ -56,6 +56,7 @@ module Tremendous
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'name',
       ])
     end