tremendous_ruby 5.21.0 → 5.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e1b3b289fa165e9aad09ff4db72e7d5a4cd7fee02df49e0e1e3900bdffa8169
-  data.tar.gz: 07e4346741282945c335770ea4efcdd45ef877621990a7e3857d5a80fe03b661
+  metadata.gz: 45254cb5062ac51da11cd26dfe924007969603695dd4e542f7bf789954732ae1
+  data.tar.gz: 78b00c774379d33fd3cbafaa9ad38897ab9d1a39071554c96f4c63143209e396
 SHA512:
-  metadata.gz: 5de40b45138974a56921e645a6134d638bb7d3a7f1fe5cde6e3da631394e978edd49e8f393bb3b436a91eeeb141e81ac87bd22924d7a5f8a309ea9bb7ef93594
-  data.tar.gz: 4bdbe2f69085434cd50e847df92c62e1d790881c0cbe6b2592dda87af5de4113bf473555b6465f5e27ec3643b9da0e852eaf61db9bb5320d92129f0d7ebb4ccc
+  metadata.gz: 5b5f47b1aff50aa826b8142aac1c6c618e24a650253712ed030a9004c9d3814cfd428c9e822cfada56cf17d4a1b54e6cd4cfd97d78e6967908b34ee09bc9d458
+  data.tar.gz: 91f7799d8927190ef8797bdec5bba156ce6667cc6274c755db2a0521174bbd92fc1bc1b97fcef55e38d3b93e346839641367b10e4d007b910cf49f8b87eddc1d

data/lib/tremendous/models/balance_transaction.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/balance_transaction_order_payment.rb

@@ -15,18 +15,21 @@ require 'time'
 
 module Tremendous
   class BalanceTransactionOrderPayment
-    # 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' => :'PaymentDetailsRefund'
       }
     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

data/lib/tremendous/models/campaign.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/campaign_base.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
 
@@ -106,6 +134,10 @@ module Tremendous
         end
       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
@@ -133,6 +165,8 @@ module Tremendous
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if !@id.nil? && @id !~ Regexp.new(/[A-Z0-9]{4,20}/)
+      fee_charged_to_validator = EnumAttributeValidator.new('String', ["SENDER", "RECIPIENT"])
+      return false unless fee_charged_to_validator.valid?(@fee_charged_to)
       true
     end
 
@@ -151,6 +185,16 @@ module Tremendous
       @id = id
     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)
@@ -160,6 +204,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
@@ -173,7 +218,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/connected_organization_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/create_campaign_request.rb

@@ -25,16 +25,42 @@ 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
       {
         :'name' => :'name',
         :'description' => :'description',
         :'products' => :'products',
+        :'fee_charged_to' => :'fee_charged_to',
         :'webpage_style' => :'webpage_style',
         :'email_style' => :'email_style'
       }
@@ -56,6 +82,7 @@ module Tremendous
         :'name' => :'String',
         :'description' => :'String',
         :'products' => :'Array<String>',
+        :'fee_charged_to' => :'String',
         :'webpage_style' => :'ListCampaigns200ResponseCampaignsInnerWebpageStyle',
         :'email_style' => :'ListCampaigns200ResponseCampaignsInnerEmailStyle'
       }
@@ -65,6 +92,7 @@ module Tremendous
     def self.openapi_nullable
       Set.new([
         :'description',
+        :'fee_charged_to',
       ])
     end
 
@@ -104,6 +132,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
@@ -135,6 +167,8 @@ module Tremendous
       warn '[DEPRECATED] the `valid?` method is obsolete'
       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
 
@@ -158,6 +192,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)
@@ -166,6 +210,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
@@ -179,7 +224,7 @@ module Tremendous
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [name, description, products, webpage_style, email_style].hash
+      [name, description, products, fee_charged_to, webpage_style, email_style].hash
     end
 
     # Builds the object from hash

data/lib/tremendous/models/create_order200_response_order.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/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