tremendous_ruby 5.21.0 → 5.22.0

data/lib/tremendous/models/single_reward_order_with_link_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/single_reward_order_without_link_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/topup.rb

@@ -18,16 +18,19 @@ module Tremendous
     # Unique identifier for the topup request.
     attr_accessor :id
 
-    # 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
 
+    # Currency of the topup amount. Always matches the organization's currency.
+    attr_accessor :currency_code
+
     # Amount of the processing fee for the topup (typically reserved for credit card topups).
     attr_accessor :processing_fee
 
     # ID of the funding_source object used for this topup.
     attr_accessor :funding_source_id
 
-    # Status of the topup <table>   <thead>     <tr>       <th>         Status       </th>       <th>         Description       </th>     </tr>   </thead>   <tbody>     <tr>       <td>         <code>           created         </code>       </td>       <td>         The topup is processing (and may be under review).       </td>     </tr>     <tr>       <td>         <code>           fully_credited         </code>       </td>       <td>         The funds have been added to the balance.       </td>     </tr>     <tr>       <td>         <code>           reversed         </code>       </td>       <td>         The topup was credited, but then reversed due to a chargeback or ACH return.       </td>     </tr>     <tr>       <td>         <code>           rejected         </code>       </td>       <td>         The topup was rejected by an admin.       </td>     </tr>   </tbody> </table> 
+    # Status of the topup <table>   <thead>     <tr>       <th>         Status       </th>       <th>         Description       </th>     </tr>   </thead>   <tbody>     <tr>       <td>         <code>           created         </code>       </td>       <td>         The topup is processing (and may be under review).       </td>     </tr>     <tr>       <td>         <code>           partially_credited         </code>       </td>       <td>         Some funds have been credited to the balance. The remainder will be credited by <code>expected_settlement_at</code>.       </td>     </tr>     <tr>       <td>         <code>           fully_credited         </code>       </td>       <td>         All funds have been added to the balance.       </td>     </tr>     <tr>       <td>         <code>           reversed         </code>       </td>       <td>         The topup was credited, but then reversed due to a chargeback or ACH return.       </td>     </tr>     <tr>       <td>         <code>           rejected         </code>       </td>       <td>         The topup was rejected by an admin.       </td>     </tr>   </tbody> </table> 
     attr_accessor :status
 
     # Timestamp indicating when the topup object was created (when the request was made).
@@ -48,11 +51,21 @@ module Tremendous
     # Idempotency key to prevent duplicate requests.
     attr_accessor :idempotency_key
 
+    # Amount credited to the balance immediately. Equals `amount` for non-ACH topups or ACH debits fully within instant funding limits. Can be 0 if nothing was credited instantly.
+    attr_accessor :instant_credit_amount
+
+    # Amount that will be available once the settlement period elapses. 0 if nothing is settling.
+    attr_accessor :settled_amount
+
+    # Timestamp indicating when the pending amount will be credited to the balance. Null if the topup was fully credited immediately.
+    attr_accessor :expected_settlement_at
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'id' => :'id',
         :'amount' => :'amount',
+        :'currency_code' => :'currency_code',
         :'processing_fee' => :'processing_fee',
         :'funding_source_id' => :'funding_source_id',
         :'status' => :'status',
@@ -61,7 +74,10 @@ module Tremendous
         :'rejected_at' => :'rejected_at',
         :'reversed_at' => :'reversed_at',
         :'reversed_reason' => :'reversed_reason',
-        :'idempotency_key' => :'idempotency_key'
+        :'idempotency_key' => :'idempotency_key',
+        :'instant_credit_amount' => :'instant_credit_amount',
+        :'settled_amount' => :'settled_amount',
+        :'expected_settlement_at' => :'expected_settlement_at'
       }
     end
 
@@ -80,6 +96,7 @@ module Tremendous
       {
         :'id' => :'String',
         :'amount' => :'Float',
+        :'currency_code' => :'String',
         :'processing_fee' => :'Float',
         :'funding_source_id' => :'String',
         :'status' => :'String',
@@ -88,7 +105,10 @@ module Tremendous
         :'rejected_at' => :'Time',
         :'reversed_at' => :'Time',
         :'reversed_reason' => :'String',
-        :'idempotency_key' => :'String'
+        :'idempotency_key' => :'String',
+        :'instant_credit_amount' => :'Float',
+        :'settled_amount' => :'Float',
+        :'expected_settlement_at' => :'Date'
       }
     end
 
@@ -99,7 +119,8 @@ module Tremendous
         :'rejected_at',
         :'reversed_at',
         :'reversed_reason',
-        :'idempotency_key'
+        :'idempotency_key',
+        :'expected_settlement_at'
       ])
     end
 
@@ -127,6 +148,10 @@ module Tremendous
         self.amount = attributes[:'amount']
       end
 
+      if attributes.key?(:'currency_code')
+        self.currency_code = attributes[:'currency_code']
+      end
+
       if attributes.key?(:'processing_fee')
         self.processing_fee = attributes[:'processing_fee']
       end
@@ -162,6 +187,18 @@ module Tremendous
       if attributes.key?(:'idempotency_key')
         self.idempotency_key = attributes[:'idempotency_key']
       end
+
+      if attributes.key?(:'instant_credit_amount')
+        self.instant_credit_amount = attributes[:'instant_credit_amount']
+      end
+
+      if attributes.key?(:'settled_amount')
+        self.settled_amount = attributes[:'settled_amount']
+      end
+
+      if attributes.key?(:'expected_settlement_at')
+        self.expected_settlement_at = attributes[:'expected_settlement_at']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -186,6 +223,7 @@ module Tremendous
       self.class == o.class &&
           id == o.id &&
           amount == o.amount &&
+          currency_code == o.currency_code &&
           processing_fee == o.processing_fee &&
           funding_source_id == o.funding_source_id &&
           status == o.status &&
@@ -194,7 +232,10 @@ module Tremendous
           rejected_at == o.rejected_at &&
           reversed_at == o.reversed_at &&
           reversed_reason == o.reversed_reason &&
-          idempotency_key == o.idempotency_key
+          idempotency_key == o.idempotency_key &&
+          instant_credit_amount == o.instant_credit_amount &&
+          settled_amount == o.settled_amount &&
+          expected_settlement_at == o.expected_settlement_at
     end
 
     # @see the `==` method
@@ -206,7 +247,7 @@ module Tremendous
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, amount, processing_fee, funding_source_id, status, created_at, fully_credited_at, rejected_at, reversed_at, reversed_reason, idempotency_key].hash
+      [id, amount, currency_code, processing_fee, funding_source_id, status, created_at, fully_credited_at, rejected_at, reversed_at, reversed_reason, idempotency_key, instant_credit_amount, settled_amount, expected_settlement_at].hash
     end
 
     # Builds the object from hash

data/lib/tremendous/models/topup_create_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/update_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
 
@@ -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/update_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
 
@@ -98,6 +126,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
@@ -119,9 +151,21 @@ module Tremendous
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
+      fee_charged_to_validator = EnumAttributeValidator.new('String', ["SENDER", "RECIPIENT"])
+      return false unless fee_charged_to_validator.valid?(@fee_charged_to)
       true
     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)
@@ -130,6 +174,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
@@ -143,7 +188,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/version.rb

@@ -1,3 +1,3 @@
 module Tremendous
-  VERSION = "5.21.0"
+  VERSION = "5.22.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tremendous_ruby
 version: !ruby/object:Gem::Version
-  version: 5.21.0
+  version: 5.22.0
 platform: ruby
 authors:
 - Tremendous Developers