tremendous_ruby 5.21.0 → 5.23.0

data/lib/tremendous/models/create_organization.rb

@@ -31,6 +31,9 @@ module Tremendous
     # Phone number of the organization. For non-US phone numbers, specify the country code (prefixed with +).
     attr_accessor :phone
 
+    # Currency code for the new organization. Defaults to the current organization's currency if not provided.
+    attr_accessor :currency_code
+
     # Timestamp of when the organization has been created. 
     attr_accessor :created_at
 
@@ -43,6 +46,7 @@ module Tremendous
         :'with_api_key' => :'with_api_key',
         :'copy_settings' => :'copy_settings',
         :'phone' => :'phone',
+        :'currency_code' => :'currency_code',
         :'created_at' => :'created_at'
       }
     end
@@ -66,6 +70,7 @@ module Tremendous
         :'with_api_key' => :'Boolean',
         :'copy_settings' => :'CreateOrganizationRequestCopySettings',
         :'phone' => :'String',
+        :'currency_code' => :'String',
         :'created_at' => :'Date'
       }
     end
@@ -122,6 +127,10 @@ module Tremendous
         self.phone = attributes[:'phone']
       end
 
+      if attributes.key?(:'currency_code')
+        self.currency_code = attributes[:'currency_code']
+      end
+
       if attributes.key?(:'created_at')
         self.created_at = attributes[:'created_at']
       end
@@ -219,6 +228,7 @@ module Tremendous
           with_api_key == o.with_api_key &&
           copy_settings == o.copy_settings &&
           phone == o.phone &&
+          currency_code == o.currency_code &&
           created_at == o.created_at
     end
 
@@ -231,7 +241,7 @@ module Tremendous
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, name, website, with_api_key, copy_settings, phone, created_at].hash
+      [id, name, website, with_api_key, copy_settings, phone, currency_code, created_at].hash
     end
 
     # Builds the object from hash

data/lib/tremendous/models/create_organization200_response_organization.rb

@@ -28,6 +28,9 @@ module Tremendous
     # Phone number of the organization. For non-US phone numbers, specify the country code (prefixed with +).
     attr_accessor :phone
 
+    # Currency code for the new organization. Defaults to the current organization's currency if not provided.
+    attr_accessor :currency_code
+
     # Timestamp of when the organization has been created. 
     attr_accessor :created_at
 
@@ -42,6 +45,7 @@ module Tremendous
         :'website' => :'website',
         :'copy_settings' => :'copy_settings',
         :'phone' => :'phone',
+        :'currency_code' => :'currency_code',
         :'created_at' => :'created_at',
         :'api_key' => :'api_key'
       }
@@ -65,6 +69,7 @@ module Tremendous
         :'website' => :'String',
         :'copy_settings' => :'CreateOrganizationRequestCopySettings',
         :'phone' => :'String',
+        :'currency_code' => :'String',
         :'created_at' => :'Date',
         :'api_key' => :'String'
       }
@@ -117,6 +122,10 @@ module Tremendous
         self.phone = attributes[:'phone']
       end
 
+      if attributes.key?(:'currency_code')
+        self.currency_code = attributes[:'currency_code']
+      end
+
       if attributes.key?(:'created_at')
         self.created_at = attributes[:'created_at']
       end
@@ -202,6 +211,7 @@ module Tremendous
           website == o.website &&
           copy_settings == o.copy_settings &&
           phone == o.phone &&
+          currency_code == o.currency_code &&
           created_at == o.created_at &&
           api_key == o.api_key
     end
@@ -215,7 +225,7 @@ module Tremendous
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, name, website, copy_settings, phone, created_at, api_key].hash
+      [id, name, website, copy_settings, phone, currency_code, created_at, api_key].hash
     end
 
     # Builds the object from hash

data/lib/tremendous/models/create_organization_for_response.rb

@@ -31,6 +31,9 @@ module Tremendous
     # Phone number of the organization. For non-US phone numbers, specify the country code (prefixed with +).
     attr_accessor :phone
 
+    # Currency code for the new organization. Defaults to the current organization's currency if not provided.
+    attr_accessor :currency_code
+
     # Timestamp of when the organization has been created. 
     attr_accessor :created_at
 
@@ -43,6 +46,7 @@ module Tremendous
         :'with_api_key' => :'with_api_key',
         :'copy_settings' => :'copy_settings',
         :'phone' => :'phone',
+        :'currency_code' => :'currency_code',
         :'created_at' => :'created_at'
       }
     end
@@ -66,6 +70,7 @@ module Tremendous
         :'with_api_key' => :'Boolean',
         :'copy_settings' => :'CreateOrganizationRequestCopySettings',
         :'phone' => :'String',
+        :'currency_code' => :'String',
         :'created_at' => :'Date'
       }
     end
@@ -121,6 +126,10 @@ module Tremendous
         self.phone = attributes[:'phone']
       end
 
+      if attributes.key?(:'currency_code')
+        self.currency_code = attributes[:'currency_code']
+      end
+
       if attributes.key?(:'created_at')
         self.created_at = attributes[:'created_at']
       end
@@ -203,6 +212,7 @@ module Tremendous
           with_api_key == o.with_api_key &&
           copy_settings == o.copy_settings &&
           phone == o.phone &&
+          currency_code == o.currency_code &&
           created_at == o.created_at
     end
 
@@ -215,7 +225,7 @@ module Tremendous
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, name, website, with_api_key, copy_settings, phone, created_at].hash
+      [id, name, website, with_api_key, copy_settings, phone, currency_code, created_at].hash
     end
 
     # Builds the object from hash

data/lib/tremendous/models/create_organization_properties.rb

@@ -31,6 +31,9 @@ module Tremendous
     # Phone number of the organization. For non-US phone numbers, specify the country code (prefixed with +).
     attr_accessor :phone
 
+    # Currency code for the new organization. Defaults to the current organization's currency if not provided.
+    attr_accessor :currency_code
+
     # Timestamp of when the organization has been created. 
     attr_accessor :created_at
 
@@ -43,6 +46,7 @@ module Tremendous
         :'with_api_key' => :'with_api_key',
         :'copy_settings' => :'copy_settings',
         :'phone' => :'phone',
+        :'currency_code' => :'currency_code',
         :'created_at' => :'created_at'
       }
     end
@@ -66,6 +70,7 @@ module Tremendous
         :'with_api_key' => :'Boolean',
         :'copy_settings' => :'CreateOrganizationRequestCopySettings',
         :'phone' => :'String',
+        :'currency_code' => :'String',
         :'created_at' => :'Date'
       }
     end
@@ -116,6 +121,10 @@ module Tremendous
         self.phone = attributes[:'phone']
       end
 
+      if attributes.key?(:'currency_code')
+        self.currency_code = attributes[:'currency_code']
+      end
+
       if attributes.key?(:'created_at')
         self.created_at = attributes[:'created_at']
       end
@@ -168,6 +177,7 @@ module Tremendous
           with_api_key == o.with_api_key &&
           copy_settings == o.copy_settings &&
           phone == o.phone &&
+          currency_code == o.currency_code &&
           created_at == o.created_at
     end
 
@@ -180,7 +190,7 @@ module Tremendous
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, name, website, with_api_key, copy_settings, phone, created_at].hash
+      [id, name, website, with_api_key, copy_settings, phone, currency_code, created_at].hash
     end
 
     # Builds the object from hash

data/lib/tremendous/models/create_organization_request.rb

@@ -29,6 +29,9 @@ module Tremendous
     # Phone number of the organization. For non-US phone numbers, specify the country code (prefixed with +).
     attr_accessor :phone
 
+    # Currency code for the new organization. Defaults to the current organization's currency if not provided.
+    attr_accessor :currency_code
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -36,7 +39,8 @@ module Tremendous
         :'website' => :'website',
         :'with_api_key' => :'with_api_key',
         :'copy_settings' => :'copy_settings',
-        :'phone' => :'phone'
+        :'phone' => :'phone',
+        :'currency_code' => :'currency_code'
       }
     end
 
@@ -57,7 +61,8 @@ module Tremendous
         :'website' => :'String',
         :'with_api_key' => :'Boolean',
         :'copy_settings' => :'CreateOrganizationRequestCopySettings',
-        :'phone' => :'String'
+        :'phone' => :'String',
+        :'currency_code' => :'String'
       }
     end
 
@@ -108,6 +113,10 @@ module Tremendous
       if attributes.key?(:'phone')
         self.phone = attributes[:'phone']
       end
+
+      if attributes.key?(:'currency_code')
+        self.currency_code = attributes[:'currency_code']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -179,7 +188,8 @@ module Tremendous
           website == o.website &&
           with_api_key == o.with_api_key &&
           copy_settings == o.copy_settings &&
-          phone == o.phone
+          phone == o.phone &&
+          currency_code == o.currency_code
     end
 
     # @see the `==` method
@@ -191,7 +201,7 @@ module Tremendous
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [name, website, with_api_key, copy_settings, phone].hash
+      [name, website, with_api_key, copy_settings, phone, currency_code].hash
     end
 
     # Builds the object from hash

data/lib/tremendous/models/create_topup_request.rb

@@ -21,7 +21,7 @@ module Tremendous
     # Unique key that ensures this request is only processed once. 
     attr_accessor :idempotency_key
 
-    # Amount in USD intended to be added to your organization’s balance.
+    # Amount to add to your organization's balance, denominated in `currency_code`.
     attr_accessor :amount
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/tremendous/models/fraud_config_redeemed_rewards_amount.rb

@@ -15,7 +15,7 @@ require 'time'
 
 module Tremendous
   class FraudConfigRedeemedRewardsAmount
-    # The total amount in USD of redeemed rewards to use as a threshold.
+    # The total amount of redeemed rewards to use as a threshold. The amount is denominated in the organization's currency.
     attr_accessor :amount
 
     # The period, in days, to consider for the count. Use `all_time` to consider any redeemed rewards.

data/lib/tremendous/models/fraud_review.rb

@@ -113,7 +113,7 @@ module Tremendous
         :'reviewed_at' => :'Time',
         :'redemption_method_account_hash' => :'String',
         :'risk' => :'String',
-        :'related_rewards' => :'GetFraudReview200ResponseFraudReviewRelatedRewards'
+        :'related_rewards' => :'FraudReviewRelatedRewards'
       }
     end
 

data/lib/tremendous/models/fraud_review_related_rewards.rb

@@ -14,6 +14,7 @@ require 'date'
 require 'time'
 
 module Tremendous
+  # The related rewards associated with the fraud review.
   class FraudReviewRelatedRewards
     # The IDs of rewards that have similar attributes to the fraud reward. A maximum of 100 IDs is returned. 
     attr_accessor :ids
@@ -24,16 +25,20 @@ module Tremendous
     # How many related rewards have been blocked.
     attr_accessor :blocked_count
 
-    # Total amount claimed by the related rewards (in USD).
+    # Total amount claimed by the related rewards, denominated in `currency_code`. 
     attr_accessor :aggregated_value
 
+    # Currency of the aggregated value. Always matches the organization's currency.
+    attr_accessor :currency_code
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'ids' => :'ids',
         :'count' => :'count',
         :'blocked_count' => :'blocked_count',
-        :'aggregated_value' => :'aggregated_value'
+        :'aggregated_value' => :'aggregated_value',
+        :'currency_code' => :'currency_code'
       }
     end
 
@@ -53,7 +58,8 @@ module Tremendous
         :'ids' => :'Array<String>',
         :'count' => :'Float',
         :'blocked_count' => :'Float',
-        :'aggregated_value' => :'Float'
+        :'aggregated_value' => :'Float',
+        :'currency_code' => :'String'
       }
     end
 
@@ -96,6 +102,10 @@ module Tremendous
       if attributes.key?(:'aggregated_value')
         self.aggregated_value = attributes[:'aggregated_value']
       end
+
+      if attributes.key?(:'currency_code')
+        self.currency_code = attributes[:'currency_code']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -178,7 +188,8 @@ module Tremendous
           ids == o.ids &&
           count == o.count &&
           blocked_count == o.blocked_count &&
-          aggregated_value == o.aggregated_value
+          aggregated_value == o.aggregated_value &&
+          currency_code == o.currency_code
     end
 
     # @see the `==` method
@@ -190,7 +201,7 @@ module Tremendous
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [ids, count, blocked_count, aggregated_value].hash
+      [ids, count, blocked_count, aggregated_value, currency_code].hash
     end
 
     # Builds the object from hash

data/lib/tremendous/models/fraud_rules_list_item.rb

@@ -16,7 +16,7 @@ require 'time'
 module Tremendous
   # An active fraud rule
   class FraudRulesListItem
-    # * `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/get_fraud_review200_response_fraud_review_related_rewards.rb

@@ -25,16 +25,20 @@ module Tremendous
     # How many related rewards have been blocked.
     attr_accessor :blocked_count
 
-    # Total amount claimed by the related rewards (in USD).
+    # Total amount claimed by the related rewards, denominated in `currency_code`. 
     attr_accessor :aggregated_value
 
+    # Currency of the aggregated value. Always matches the organization's currency.
+    attr_accessor :currency_code
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'ids' => :'ids',
         :'count' => :'count',
         :'blocked_count' => :'blocked_count',
-        :'aggregated_value' => :'aggregated_value'
+        :'aggregated_value' => :'aggregated_value',
+        :'currency_code' => :'currency_code'
       }
     end
 
@@ -54,7 +58,8 @@ module Tremendous
         :'ids' => :'Array<String>',
         :'count' => :'Float',
         :'blocked_count' => :'Float',
-        :'aggregated_value' => :'Float'
+        :'aggregated_value' => :'Float',
+        :'currency_code' => :'String'
       }
     end
 
@@ -97,6 +102,10 @@ module Tremendous
       if attributes.key?(:'aggregated_value')
         self.aggregated_value = attributes[:'aggregated_value']
       end
+
+      if attributes.key?(:'currency_code')
+        self.currency_code = attributes[:'currency_code']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -179,7 +188,8 @@ module Tremendous
           ids == o.ids &&
           count == o.count &&
           blocked_count == o.blocked_count &&
-          aggregated_value == o.aggregated_value
+          aggregated_value == o.aggregated_value &&
+          currency_code == o.currency_code
     end
 
     # @see the `==` method
@@ -191,7 +201,7 @@ module Tremendous
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [ids, count, blocked_count, aggregated_value].hash
+      [ids, count, blocked_count, aggregated_value, currency_code].hash
     end
 
     # Builds the object from hash

data/lib/tremendous/models/list_balance_transactions200_response_transactions_inner.rb

@@ -19,10 +19,13 @@ module Tremendous
     # Date that the transaction was created
     attr_accessor :created_at
 
-    # Amount of the transaction in USD
+    # Amount of the transaction, denominated in `currency_code`.
     attr_accessor :amount
 
-    # The updated total after the transaction. Note that this running balance may be delayed and contain `null`.
+    # Currency of the transaction amount and running balance. Always matches the organization's currency.
+    attr_accessor :currency_code
+
+    # The updated total after the transaction, denominated in `currency_code`. Note that this running balance may be delayed and contain `null`.
     attr_accessor :balance
 
     # The action that was performed
@@ -38,6 +41,7 @@ module Tremendous
       {
         :'created_at' => :'created_at',
         :'amount' => :'amount',
+        :'currency_code' => :'currency_code',
         :'balance' => :'balance',
         :'action' => :'action',
         :'description' => :'description',
@@ -60,6 +64,7 @@ module Tremendous
       {
         :'created_at' => :'Time',
         :'amount' => :'Float',
+        :'currency_code' => :'String',
         :'balance' => :'Float',
         :'action' => :'String',
         :'description' => :'String',
@@ -101,6 +106,12 @@ module Tremendous
         self.amount = nil
       end
 
+      if attributes.key?(:'currency_code')
+        self.currency_code = attributes[:'currency_code']
+      else
+        self.currency_code = nil
+      end
+
       if attributes.key?(:'balance')
         self.balance = attributes[:'balance']
       else
@@ -137,6 +148,10 @@ module Tremendous
         invalid_properties.push('invalid value for "amount", amount cannot be nil.')
       end
 
+      if @currency_code.nil?
+        invalid_properties.push('invalid value for "currency_code", currency_code cannot be nil.')
+      end
+
       if @balance.nil?
         invalid_properties.push('invalid value for "balance", balance cannot be nil.')
       end
@@ -158,6 +173,7 @@ module Tremendous
       warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if @created_at.nil?
       return false if @amount.nil?
+      return false if @currency_code.nil?
       return false if @balance.nil?
       return false if @action.nil?
       return false if @description.nil?
@@ -184,6 +200,16 @@ module Tremendous
       @amount = amount
     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
+
     # Custom attribute writer method with validation
     # @param [Object] balance Value to be assigned
     def balance=(balance)
@@ -221,6 +247,7 @@ module Tremendous
       self.class == o.class &&
           created_at == o.created_at &&
           amount == o.amount &&
+          currency_code == o.currency_code &&
           balance == o.balance &&
           action == o.action &&
           description == o.description &&
@@ -236,7 +263,7 @@ module Tremendous
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [created_at, amount, balance, action, description, order].hash
+      [created_at, amount, currency_code, balance, action, description, order].hash
     end
 
     # Builds the object from hash

data/lib/tremendous/models/list_balance_transactions200_response_transactions_inner_order_payment.rb

@@ -15,18 +15,21 @@ require 'time'
 
 module Tremendous
   class ListBalanceTransactions200ResponseTransactionsInnerOrderPayment
-    # 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.
@@ -36,6 +39,7 @@ module Tremendous
         :'total' => :'total',
         :'fees' => :'fees',
         :'discount' => :'discount',
+        :'currency_code' => :'currency_code',
         :'refund' => :'refund'
       }
     end
@@ -57,6 +61,7 @@ module Tremendous
         :'total' => :'Float',
         :'fees' => :'Float',
         :'discount' => :'Float',
+        :'currency_code' => :'String',
         :'refund' => :'ListOrders200ResponseOrdersInnerPaymentRefund'
       }
     end
@@ -107,6 +112,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
@@ -149,6 +160,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
 
@@ -164,6 +179,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
 
@@ -223,6 +239,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)
@@ -232,6 +258,7 @@ module Tremendous
           total == o.total &&
           fees == o.fees &&
           discount == o.discount &&
+          currency_code == o.currency_code &&
           refund == o.refund
     end
 
@@ -244,7 +271,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