tremendous_ruby 5.24.0 → 5.28.0

data/lib/tremendous/models/campaign.rb

@@ -30,6 +30,8 @@ module Tremendous
     # 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 :auto_add_product_rule
+
     attr_accessor :webpage_style
 
     attr_accessor :email_style
@@ -64,6 +66,7 @@ module Tremendous
         :'description' => :'description',
         :'products' => :'products',
         :'fee_charged_to' => :'fee_charged_to',
+        :'auto_add_product_rule' => :'auto_add_product_rule',
         :'webpage_style' => :'webpage_style',
         :'email_style' => :'email_style'
       }
@@ -87,6 +90,7 @@ module Tremendous
         :'description' => :'String',
         :'products' => :'Array<String>',
         :'fee_charged_to' => :'String',
+        :'auto_add_product_rule' => :'ListCampaigns200ResponseCampaignsInnerAutoAddProductRule',
         :'webpage_style' => :'ListCampaigns200ResponseCampaignsInnerWebpageStyle',
         :'email_style' => :'ListCampaigns200ResponseCampaignsInnerEmailStyle'
       }
@@ -97,6 +101,7 @@ module Tremendous
       Set.new([
         :'description',
         :'fee_charged_to',
+        :'auto_add_product_rule',
       ])
     end
 
@@ -144,6 +149,10 @@ module Tremendous
         self.fee_charged_to = attributes[:'fee_charged_to']
       end
 
+      if attributes.key?(:'auto_add_product_rule')
+        self.auto_add_product_rule = attributes[:'auto_add_product_rule']
+      end
+
       if attributes.key?(:'webpage_style')
         self.webpage_style = attributes[:'webpage_style']
       end
@@ -221,13 +230,11 @@ module Tremendous
       @products = products
     end
 
-    # Custom attribute writer method checking allowed values (enum).
+    # Custom attribute writer method for enum attributes. Any value is accepted
+    # so that enum values added to the API don't break deserialization on
+    # older versions of this gem.
     # @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
 
@@ -241,6 +248,7 @@ module Tremendous
           description == o.description &&
           products == o.products &&
           fee_charged_to == o.fee_charged_to &&
+          auto_add_product_rule == o.auto_add_product_rule &&
           webpage_style == o.webpage_style &&
           email_style == o.email_style
     end
@@ -254,7 +262,7 @@ module Tremendous
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, name, description, products, fee_charged_to, webpage_style, email_style].hash
+      [id, name, description, products, fee_charged_to, auto_add_product_rule, webpage_style, email_style].hash
     end
 
     # Builds the object from hash

data/lib/tremendous/models/campaign_base.rb

@@ -30,6 +30,8 @@ module Tremendous
     # 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 :auto_add_product_rule
+
     attr_accessor :webpage_style
 
     attr_accessor :email_style
@@ -64,6 +66,7 @@ module Tremendous
         :'description' => :'description',
         :'products' => :'products',
         :'fee_charged_to' => :'fee_charged_to',
+        :'auto_add_product_rule' => :'auto_add_product_rule',
         :'webpage_style' => :'webpage_style',
         :'email_style' => :'email_style'
       }
@@ -87,6 +90,7 @@ module Tremendous
         :'description' => :'String',
         :'products' => :'Array<String>',
         :'fee_charged_to' => :'String',
+        :'auto_add_product_rule' => :'ListCampaigns200ResponseCampaignsInnerAutoAddProductRule',
         :'webpage_style' => :'ListCampaigns200ResponseCampaignsInnerWebpageStyle',
         :'email_style' => :'ListCampaigns200ResponseCampaignsInnerEmailStyle'
       }
@@ -97,6 +101,7 @@ module Tremendous
       Set.new([
         :'description',
         :'fee_charged_to',
+        :'auto_add_product_rule',
       ])
     end
 
@@ -138,6 +143,10 @@ module Tremendous
         self.fee_charged_to = attributes[:'fee_charged_to']
       end
 
+      if attributes.key?(:'auto_add_product_rule')
+        self.auto_add_product_rule = attributes[:'auto_add_product_rule']
+      end
+
       if attributes.key?(:'webpage_style')
         self.webpage_style = attributes[:'webpage_style']
       end
@@ -185,13 +194,11 @@ module Tremendous
       @id = id
     end
 
-    # Custom attribute writer method checking allowed values (enum).
+    # Custom attribute writer method for enum attributes. Any value is accepted
+    # so that enum values added to the API don't break deserialization on
+    # older versions of this gem.
     # @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
 
@@ -205,6 +212,7 @@ module Tremendous
           description == o.description &&
           products == o.products &&
           fee_charged_to == o.fee_charged_to &&
+          auto_add_product_rule == o.auto_add_product_rule &&
           webpage_style == o.webpage_style &&
           email_style == o.email_style
     end
@@ -218,7 +226,7 @@ module Tremendous
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, name, description, products, fee_charged_to, webpage_style, email_style].hash
+      [id, name, description, products, fee_charged_to, auto_add_product_rule, webpage_style, email_style].hash
     end
 
     # Builds the object from hash

data/lib/tremendous/models/connected_organization_member_member.rb

@@ -228,13 +228,15 @@ module Tremendous
       @email = email
     end
 
-    # Custom attribute writer method checking allowed values (enum).
+    # Custom attribute writer method for enum attributes. Any value is accepted
+    # so that enum values added to the API don't break deserialization on
+    # older versions of this gem.
     # @param [Object] status Object to be assigned
     def status=(status)
-      validator = EnumAttributeValidator.new('String', ["REGISTERED", "INVITED"])
-      unless validator.valid?(status)
-        fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
+      if status.nil?
+        fail ArgumentError, 'status cannot be nil'
       end
+
       @status = status
     end
 

data/lib/tremendous/models/connected_organization_member_session.rb

@@ -24,6 +24,9 @@ module Tremendous
     # The URL used for links that redirect the user back to your site when they've completed their actions on Tremendous.
     attr_accessor :return_url
 
+    # The opaque `state` value provided when the session was created, forwarded on the initial OAuth grant redirect. `null` when no value was set.
+    attr_accessor :state
+
     # Timestamp of when the session will expire.
     attr_accessor :expires_at
 
@@ -36,6 +39,7 @@ module Tremendous
         :'connected_organization_member_id' => :'connected_organization_member_id',
         :'url' => :'url',
         :'return_url' => :'return_url',
+        :'state' => :'state',
         :'expires_at' => :'expires_at',
         :'created_at' => :'created_at'
       }
@@ -57,6 +61,7 @@ module Tremendous
         :'connected_organization_member_id' => :'String',
         :'url' => :'String',
         :'return_url' => :'String',
+        :'state' => :'String',
         :'expires_at' => :'Time',
         :'created_at' => :'Time'
       }
@@ -65,6 +70,7 @@ module Tremendous
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'state',
       ])
     end
 
@@ -102,6 +108,10 @@ module Tremendous
         self.return_url = nil
       end
 
+      if attributes.key?(:'state')
+        self.state = attributes[:'state']
+      end
+
       if attributes.key?(:'expires_at')
         self.expires_at = attributes[:'expires_at']
       else
@@ -137,6 +147,10 @@ module Tremendous
         invalid_properties.push('invalid value for "return_url", return_url cannot be nil.')
       end
 
+      if !@state.nil? && @state.to_s.length > 1024
+        invalid_properties.push('invalid value for "state", the character length must be smaller than or equal to 1024.')
+      end
+
       if @expires_at.nil?
         invalid_properties.push('invalid value for "expires_at", expires_at cannot be nil.')
       end
@@ -156,6 +170,7 @@ module Tremendous
       return false if @connected_organization_member_id !~ Regexp.new(/[A-Z0-9]{4,20}/)
       return false if @url.nil?
       return false if @return_url.nil?
+      return false if !@state.nil? && @state.to_s.length > 1024
       return false if @expires_at.nil?
       return false if @created_at.nil?
       true
@@ -196,6 +211,16 @@ module Tremendous
       @return_url = return_url
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] state Value to be assigned
+    def state=(state)
+      if !state.nil? && state.to_s.length > 1024
+        fail ArgumentError, 'invalid value for "state", the character length must be smaller than or equal to 1024.'
+      end
+
+      @state = state
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] expires_at Value to be assigned
     def expires_at=(expires_at)
@@ -224,6 +249,7 @@ module Tremendous
           connected_organization_member_id == o.connected_organization_member_id &&
           url == o.url &&
           return_url == o.return_url &&
+          state == o.state &&
           expires_at == o.expires_at &&
           created_at == o.created_at
     end
@@ -237,7 +263,7 @@ module Tremendous
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [connected_organization_member_id, url, return_url, expires_at, created_at].hash
+      [connected_organization_member_id, url, return_url, state, expires_at, created_at].hash
     end
 
     # Builds the object from hash

data/lib/tremendous/models/connected_organization_organization.rb

@@ -208,13 +208,11 @@ module Tremendous
       @website = website
     end
 
-    # Custom attribute writer method checking allowed values (enum).
+    # Custom attribute writer method for enum attributes. Any value is accepted
+    # so that enum values added to the API don't break deserialization on
+    # older versions of this gem.
     # @param [Object] status Object to be assigned
     def status=(status)
-      validator = EnumAttributeValidator.new('String', ["PENDING", "APPROVED", "REJECTED"])
-      unless validator.valid?(status)
-        fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
-      end
       @status = status
     end
 

data/lib/tremendous/models/{generate_reward_token200_response_reward.rb → create_api_key_request.rb}

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 2
 Contact: developers@tremendous.com
 Generated by: https://openapi-generator.tech
-Generator version: 7.8.0
+Generator version: 7.12.0
 
 =end
 
@@ -14,37 +14,53 @@ require 'date'
 require 'time'
 
 module Tremendous
-  # The redemption token for a reward.
-  class GenerateRewardToken200ResponseReward
-    # Tremendous ID of the reward
-    attr_accessor :id
-
-    # The token to redeem the reward. 
-    attr_accessor :token
+  class CreateApiKeyRequest
+    # The key's permission level. `read_write` (the default) can make any request. `read_only` keys can't run data-altering requests: they're limited to GET requests and non-writing POST requests, like `/reports`. Omit for `read_write`. 
+    attr_accessor :permission
+
+    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
 
-    # Date the token expires
-    attr_accessor :expires_at
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'id' => :'id',
-        :'token' => :'token',
-        :'expires_at' => :'expires_at'
+        :'permission' => :'permission'
       }
     end
 
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
     # Returns all the JSON keys this model knows about
     def self.acceptable_attributes
-      attribute_map.values
+      acceptable_attribute_map.values
     end
 
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'id' => :'String',
-        :'token' => :'String',
-        :'expires_at' => :'Time'
+        :'permission' => :'String'
       }
     end
 
@@ -58,27 +74,22 @@ module Tremendous
     # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
       if (!attributes.is_a?(Hash))
-        fail ArgumentError, "The input argument (attributes) must be a hash in `Tremendous::GenerateRewardToken200ResponseReward` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Tremendous::CreateApiKeyRequest` initialize method"
       end
 
       # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
       attributes = attributes.each_with_object({}) { |(k, v), h|
-        if (!self.class.attribute_map.key?(k.to_sym))
-          fail ArgumentError, "`#{k}` is not a valid attribute in `Tremendous::GenerateRewardToken200ResponseReward`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Tremendous::CreateApiKeyRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'id')
-        self.id = attributes[:'id']
-      end
-
-      if attributes.key?(:'token')
-        self.token = attributes[:'token']
-      end
-
-      if attributes.key?(:'expires_at')
-        self.expires_at = attributes[:'expires_at']
+      if attributes.key?(:'permission')
+        self.permission = attributes[:'permission']
+      else
+        self.permission = 'read_write'
       end
     end
 
@@ -87,11 +98,6 @@ module Tremendous
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
-      pattern = Regexp.new(/[A-Z0-9]{4,20}/)
-      if !@id.nil? && @id !~ pattern
-        invalid_properties.push("invalid value for \"id\", must conform to the pattern #{pattern}.")
-      end
-
       invalid_properties
     end
 
@@ -99,23 +105,17 @@ module Tremendous
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      return false if !@id.nil? && @id !~ Regexp.new(/[A-Z0-9]{4,20}/)
+      permission_validator = EnumAttributeValidator.new('String', ["read_write", "read_only"])
+      return false unless permission_validator.valid?(@permission)
       true
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] id Value to be assigned
-    def id=(id)
-      if id.nil?
-        fail ArgumentError, 'id cannot be nil'
-      end
-
-      pattern = Regexp.new(/[A-Z0-9]{4,20}/)
-      if id !~ pattern
-        fail ArgumentError, "invalid value for \"id\", must conform to the pattern #{pattern}."
-      end
-
-      @id = id
+    # Custom attribute writer method for enum attributes. Any value is accepted
+    # so that enum values added to the API don't break deserialization on
+    # older versions of this gem.
+    # @param [Object] permission Object to be assigned
+    def permission=(permission)
+      @permission = permission
     end
 
     # Checks equality by comparing each attribute.
@@ -123,9 +123,7 @@ module Tremendous
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          id == o.id &&
-          token == o.token &&
-          expires_at == o.expires_at
+          permission == o.permission
     end
 
     # @see the `==` method
@@ -137,7 +135,7 @@ module Tremendous
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, token, expires_at].hash
+      [permission].hash
     end
 
     # Builds the object from hash

data/lib/tremendous/models/create_campaign_request.rb

@@ -28,6 +28,8 @@ module Tremendous
     # 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 :auto_add_product_rule
+
     attr_accessor :webpage_style
 
     attr_accessor :email_style
@@ -61,6 +63,7 @@ module Tremendous
         :'description' => :'description',
         :'products' => :'products',
         :'fee_charged_to' => :'fee_charged_to',
+        :'auto_add_product_rule' => :'auto_add_product_rule',
         :'webpage_style' => :'webpage_style',
         :'email_style' => :'email_style'
       }
@@ -83,6 +86,7 @@ module Tremendous
         :'description' => :'String',
         :'products' => :'Array<String>',
         :'fee_charged_to' => :'String',
+        :'auto_add_product_rule' => :'ListCampaigns200ResponseCampaignsInnerAutoAddProductRule',
         :'webpage_style' => :'ListCampaigns200ResponseCampaignsInnerWebpageStyle',
         :'email_style' => :'ListCampaigns200ResponseCampaignsInnerEmailStyle'
       }
@@ -93,6 +97,7 @@ module Tremendous
       Set.new([
         :'description',
         :'fee_charged_to',
+        :'auto_add_product_rule',
       ])
     end
 
@@ -136,6 +141,10 @@ module Tremendous
         self.fee_charged_to = attributes[:'fee_charged_to']
       end
 
+      if attributes.key?(:'auto_add_product_rule')
+        self.auto_add_product_rule = attributes[:'auto_add_product_rule']
+      end
+
       if attributes.key?(:'webpage_style')
         self.webpage_style = attributes[:'webpage_style']
       end
@@ -192,13 +201,11 @@ module Tremendous
       @products = products
     end
 
-    # Custom attribute writer method checking allowed values (enum).
+    # Custom attribute writer method for enum attributes. Any value is accepted
+    # so that enum values added to the API don't break deserialization on
+    # older versions of this gem.
     # @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
 
@@ -211,6 +218,7 @@ module Tremendous
           description == o.description &&
           products == o.products &&
           fee_charged_to == o.fee_charged_to &&
+          auto_add_product_rule == o.auto_add_product_rule &&
           webpage_style == o.webpage_style &&
           email_style == o.email_style
     end
@@ -224,7 +232,7 @@ module Tremendous
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [name, description, products, fee_charged_to, webpage_style, email_style].hash
+      [name, description, products, fee_charged_to, auto_add_product_rule, webpage_style, email_style].hash
     end
 
     # Builds the object from hash

data/lib/tremendous/models/create_connected_organization_member_session200_response_connected_organization_member_session.rb

@@ -24,6 +24,9 @@ module Tremendous
     # The URL used for links that redirect the user back to your site when they've completed their actions on Tremendous.
     attr_accessor :return_url
 
+    # The opaque `state` value provided when the session was created, forwarded on the initial OAuth grant redirect. `null` when no value was set.
+    attr_accessor :state
+
     # Timestamp of when the session will expire.
     attr_accessor :expires_at
 
@@ -36,6 +39,7 @@ module Tremendous
         :'connected_organization_member_id' => :'connected_organization_member_id',
         :'url' => :'url',
         :'return_url' => :'return_url',
+        :'state' => :'state',
         :'expires_at' => :'expires_at',
         :'created_at' => :'created_at'
       }
@@ -57,6 +61,7 @@ module Tremendous
         :'connected_organization_member_id' => :'String',
         :'url' => :'String',
         :'return_url' => :'String',
+        :'state' => :'String',
         :'expires_at' => :'Time',
         :'created_at' => :'Time'
       }
@@ -65,6 +70,7 @@ module Tremendous
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'state',
       ])
     end
 
@@ -102,6 +108,10 @@ module Tremendous
         self.return_url = nil
       end
 
+      if attributes.key?(:'state')
+        self.state = attributes[:'state']
+      end
+
       if attributes.key?(:'expires_at')
         self.expires_at = attributes[:'expires_at']
       else
@@ -137,6 +147,10 @@ module Tremendous
         invalid_properties.push('invalid value for "return_url", return_url cannot be nil.')
       end
 
+      if !@state.nil? && @state.to_s.length > 1024
+        invalid_properties.push('invalid value for "state", the character length must be smaller than or equal to 1024.')
+      end
+
       if @expires_at.nil?
         invalid_properties.push('invalid value for "expires_at", expires_at cannot be nil.')
       end
@@ -156,6 +170,7 @@ module Tremendous
       return false if @connected_organization_member_id !~ Regexp.new(/[A-Z0-9]{4,20}/)
       return false if @url.nil?
       return false if @return_url.nil?
+      return false if !@state.nil? && @state.to_s.length > 1024
       return false if @expires_at.nil?
       return false if @created_at.nil?
       true
@@ -196,6 +211,16 @@ module Tremendous
       @return_url = return_url
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] state Value to be assigned
+    def state=(state)
+      if !state.nil? && state.to_s.length > 1024
+        fail ArgumentError, 'invalid value for "state", the character length must be smaller than or equal to 1024.'
+      end
+
+      @state = state
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] expires_at Value to be assigned
     def expires_at=(expires_at)
@@ -224,6 +249,7 @@ module Tremendous
           connected_organization_member_id == o.connected_organization_member_id &&
           url == o.url &&
           return_url == o.return_url &&
+          state == o.state &&
           expires_at == o.expires_at &&
           created_at == o.created_at
     end
@@ -237,7 +263,7 @@ module Tremendous
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [connected_organization_member_id, url, return_url, expires_at, created_at].hash
+      [connected_organization_member_id, url, return_url, state, expires_at, created_at].hash
     end
 
     # Builds the object from hash