tremendous_ruby 5.0.1 → 5.1.0

data/lib/tremendous/models/{list_products200_response.rb → create_campaign_request.rb}

@@ -14,13 +14,29 @@ require 'date'
 require 'time'
 
 module Tremendous
-  class ListProducts200Response
+  # With a campaign you can define the look & feel of how rewards are sent out. It also lets you set the available products (different gift cards, charity, etc.) recipients can choose from. 
+  class CreateCampaignRequest
+    # Name of the campaign
+    attr_accessor :name
+
+    # Description of the campaign
+    attr_accessor :description
+
+    # List of IDs of products (different gift cards, charity, etc.) that are available in this campaign. 
     attr_accessor :products
 
+    attr_accessor :webpage_style
+
+    attr_accessor :email_style
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'products' => :'products'
+        :'name' => :'name',
+        :'description' => :'description',
+        :'products' => :'products',
+        :'webpage_style' => :'webpage_style',
+        :'email_style' => :'email_style'
       }
     end
 
@@ -32,13 +48,18 @@ module Tremendous
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'products' => :'Array<ListProducts200ResponseProductsInner>'
+        :'name' => :'String',
+        :'description' => :'String',
+        :'products' => :'Array<String>',
+        :'webpage_style' => :'ListCampaigns200ResponseCampaignsInnerWebpageStyle',
+        :'email_style' => :'ListCampaigns200ResponseCampaignsInnerEmailStyle'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'description',
       ])
     end
 
@@ -46,17 +67,29 @@ 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::ListProducts200Response` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Tremendous::CreateCampaignRequest` initialize method"
       end
 
       # check to see if the attribute exists and convert string to symbol for hash key
       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::ListProducts200Response`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Tremendous::CreateCampaignRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      else
+        self.name = nil
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      else
+        self.description = nil
+      end
+
       if attributes.key?(:'products')
         if (value = attributes[:'products']).is_a?(Array)
           self.products = value
@@ -64,6 +97,14 @@ module Tremendous
       else
         self.products = nil
       end
+
+      if attributes.key?(:'webpage_style')
+        self.webpage_style = attributes[:'webpage_style']
+      end
+
+      if attributes.key?(:'email_style')
+        self.email_style = attributes[:'email_style']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -71,6 +112,10 @@ module Tremendous
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
+      if @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
       if @products.nil?
         invalid_properties.push('invalid value for "products", products cannot be nil.')
       end
@@ -82,6 +127,7 @@ module Tremendous
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @name.nil?
       return false if @products.nil?
       true
     end
@@ -91,7 +137,11 @@ module Tremendous
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          products == o.products
+          name == o.name &&
+          description == o.description &&
+          products == o.products &&
+          webpage_style == o.webpage_style &&
+          email_style == o.email_style
     end
 
     # @see the `==` method
@@ -103,7 +153,7 @@ module Tremendous
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [products].hash
+      [name, description, products, webpage_style, email_style].hash
     end
 
     # Builds the object from hash

data/lib/tremendous/models/create_member.rb

@@ -18,9 +18,6 @@ module Tremendous
     # Email address of the member
     attr_accessor :email
 
-    # Full name of the member
-    attr_accessor :name
-
     # Role of the member within the organization.  <table>   <thead>     <tr>       <th>Role</th>       <th>Description</th>     </tr>   </thead>     <tr>       <td><code>MEMBER</code></td>       <td>Limited permissions. Can view their own reward and order histories only.</td>     </tr>     <tr>       <td><code>ADMIN</code></td>       <td>Update organization settings, invite other members to the organization, and view all member order and reward histories within their organization.</td>     </tr>   <tbody> </table> 
     attr_accessor :role
 
@@ -50,7 +47,6 @@ module Tremendous
     def self.attribute_map
       {
         :'email' => :'email',
-        :'name' => :'name',
         :'role' => :'role'
       }
     end
@@ -64,7 +60,6 @@ module Tremendous
     def self.openapi_types
       {
         :'email' => :'String',
-        :'name' => :'String',
         :'role' => :'String'
       }
     end
@@ -96,12 +91,6 @@ module Tremendous
         self.email = nil
       end
 
-      if attributes.key?(:'name')
-        self.name = attributes[:'name']
-      else
-        self.name = nil
-      end
-
       if attributes.key?(:'role')
         self.role = attributes[:'role']
       else
@@ -118,10 +107,6 @@ module Tremendous
         invalid_properties.push('invalid value for "email", email cannot be nil.')
       end
 
-      if @name.nil?
-        invalid_properties.push('invalid value for "name", name cannot be nil.')
-      end
-
       if @role.nil?
         invalid_properties.push('invalid value for "role", role cannot be nil.')
       end
@@ -134,7 +119,6 @@ module Tremendous
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if @email.nil?
-      return false if @name.nil?
       return false if @role.nil?
       role_validator = EnumAttributeValidator.new('String', ["MEMBER", "ADMIN"])
       return false unless role_validator.valid?(@role)
@@ -157,7 +141,6 @@ module Tremendous
       return true if self.equal?(o)
       self.class == o.class &&
           email == o.email &&
-          name == o.name &&
           role == o.role
     end
 
@@ -170,7 +153,7 @@ module Tremendous
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [email, name, role].hash
+      [email, role].hash
     end
 
     # Builds the object from hash

data/lib/tremendous/models/create_member_request.rb

@@ -18,9 +18,6 @@ module Tremendous
     # Email address of the member
     attr_accessor :email
 
-    # Full name of the member
-    attr_accessor :name
-
     # Role of the member within the organization.  <table>   <thead>     <tr>       <th>Role</th>       <th>Description</th>     </tr>   </thead>     <tr>       <td><code>MEMBER</code></td>       <td>Limited permissions. Can view their own reward and order histories only.</td>     </tr>     <tr>       <td><code>ADMIN</code></td>       <td>Update organization settings, invite other members to the organization, and view all member order and reward histories within their organization.</td>     </tr>   <tbody> </table> 
     attr_accessor :role
 
@@ -50,7 +47,6 @@ module Tremendous
     def self.attribute_map
       {
         :'email' => :'email',
-        :'name' => :'name',
         :'role' => :'role'
       }
     end
@@ -64,7 +60,6 @@ module Tremendous
     def self.openapi_types
       {
         :'email' => :'String',
-        :'name' => :'String',
         :'role' => :'String'
       }
     end
@@ -96,12 +91,6 @@ module Tremendous
         self.email = nil
       end
 
-      if attributes.key?(:'name')
-        self.name = attributes[:'name']
-      else
-        self.name = nil
-      end
-
       if attributes.key?(:'role')
         self.role = attributes[:'role']
       else
@@ -118,10 +107,6 @@ module Tremendous
         invalid_properties.push('invalid value for "email", email cannot be nil.')
       end
 
-      if @name.nil?
-        invalid_properties.push('invalid value for "name", name cannot be nil.')
-      end
-
       if @role.nil?
         invalid_properties.push('invalid value for "role", role cannot be nil.')
       end
@@ -134,7 +119,6 @@ module Tremendous
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if @email.nil?
-      return false if @name.nil?
       return false if @role.nil?
       role_validator = EnumAttributeValidator.new('String', ["MEMBER", "ADMIN"])
       return false unless role_validator.valid?(@role)
@@ -157,7 +141,6 @@ module Tremendous
       return true if self.equal?(o)
       self.class == o.class &&
           email == o.email &&
-          name == o.name &&
           role == o.role
     end
 
@@ -170,7 +153,7 @@ module Tremendous
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [email, name, role].hash
+      [email, role].hash
     end
 
     # Builds the object from hash

data/lib/tremendous/models/create_order_request_reward.rb

@@ -63,7 +63,7 @@ module Tremendous
         :'value' => :'ListRewards200ResponseRewardsInnerValue',
         :'recipient' => :'ListRewards200ResponseRewardsInnerRecipient',
         :'deliver_at' => :'Date',
-        :'custom_fields' => :'Array<ListRewards200ResponseRewardsInnerCustomFieldsInner>',
+        :'custom_fields' => :'Array<CreateOrderRequestRewardCustomFieldsInner>',
         :'language' => :'String',
         :'delivery' => :'CreateOrderRequestRewardDelivery'
       }

data/lib/tremendous/models/{get_product200_response.rb → create_order_request_reward_custom_fields_inner.rb}

@@ -14,13 +14,19 @@ require 'date'
 require 'time'
 
 module Tremendous
-  class GetProduct200Response
-    attr_accessor :product
+  # Reward custom data for searching, tracking or copy (see [Adding custom fields to orders](https://developers.tremendous.com/reference/using-custom-fields-to-add-custom-data-to-rewards).)
+  class CreateOrderRequestRewardCustomFieldsInner
+    # Tremendous ID of the custom field
+    attr_accessor :id
+
+    # Value of the custom field
+    attr_accessor :value
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'product' => :'product'
+        :'id' => :'id',
+        :'value' => :'value'
       }
     end
 
@@ -32,13 +38,15 @@ module Tremendous
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'product' => :'ListProducts200ResponseProductsInner'
+        :'id' => :'String',
+        :'value' => :'String'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'value'
       ])
     end
 
@@ -46,21 +54,23 @@ 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::GetProduct200Response` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Tremendous::CreateOrderRequestRewardCustomFieldsInner` initialize method"
       end
 
       # check to see if the attribute exists and convert string to symbol for hash key
       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::GetProduct200Response`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Tremendous::CreateOrderRequestRewardCustomFieldsInner`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'product')
-        self.product = attributes[:'product']
-      else
-        self.product = nil
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'value')
+        self.value = attributes[:'value']
       end
     end
 
@@ -69,8 +79,9 @@ module Tremendous
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
-      if @product.nil?
-        invalid_properties.push('invalid value for "product", product cannot be nil.')
+      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
@@ -80,16 +91,32 @@ module Tremendous
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      return false if @product.nil?
+      return false if !@id.nil? && @id !~ Regexp.new(/[A-Z0-9]{4,20}/)
       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
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          product == o.product
+          id == o.id &&
+          value == o.value
     end
 
     # @see the `==` method
@@ -101,7 +128,7 @@ module Tremendous
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [product].hash
+      [id, value].hash
     end
 
     # Builds the object from hash

data/lib/tremendous/models/create_organization_request_copy_settings.rb

@@ -34,6 +34,9 @@ module Tremendous
     # Copy over the users from the current organization to the new organization. Defaults to `false`.
     attr_accessor :users
 
+    # Copy over the fraud prevention settings and rules from the current organization to the new organization. Defaults to `false`.
+    attr_accessor :fraud_prevention
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -42,7 +45,8 @@ module Tremendous
         :'order_approvals' => :'order_approvals',
         :'payment_methods' => :'payment_methods',
         :'security_settings' => :'security_settings',
-        :'users' => :'users'
+        :'users' => :'users',
+        :'fraud_prevention' => :'fraud_prevention'
       }
     end
 
@@ -59,7 +63,8 @@ module Tremendous
         :'order_approvals' => :'Boolean',
         :'payment_methods' => :'Boolean',
         :'security_settings' => :'Boolean',
-        :'users' => :'Boolean'
+        :'users' => :'Boolean',
+        :'fraud_prevention' => :'Boolean'
       }
     end
 
@@ -119,6 +124,12 @@ module Tremendous
       else
         self.users = false
       end
+
+      if attributes.key?(:'fraud_prevention')
+        self.fraud_prevention = attributes[:'fraud_prevention']
+      else
+        self.fraud_prevention = false
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -146,7 +157,8 @@ module Tremendous
           order_approvals == o.order_approvals &&
           payment_methods == o.payment_methods &&
           security_settings == o.security_settings &&
-          users == o.users
+          users == o.users &&
+          fraud_prevention == o.fraud_prevention
     end
 
     # @see the `==` method
@@ -158,7 +170,7 @@ module Tremendous
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [campaigns, custom_fields, order_approvals, payment_methods, security_settings, users].hash
+      [campaigns, custom_fields, order_approvals, payment_methods, security_settings, users, fraud_prevention].hash
     end
 
     # Builds the object from hash

data/lib/tremendous/models/custom_field.rb

@@ -22,11 +22,15 @@ module Tremendous
     # Value of the custom field
     attr_accessor :value
 
+    # Label of the custom field
+    attr_accessor :label
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'id' => :'id',
-        :'value' => :'value'
+        :'value' => :'value',
+        :'label' => :'label'
       }
     end
 
@@ -39,14 +43,15 @@ module Tremendous
     def self.openapi_types
       {
         :'id' => :'String',
-        :'value' => :'String'
+        :'value' => :'String',
+        :'label' => :'String'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'value'
+        :'value',
       ])
     end
 
@@ -72,6 +77,10 @@ module Tremendous
       if attributes.key?(:'value')
         self.value = attributes[:'value']
       end
+
+      if attributes.key?(:'label')
+        self.label = attributes[:'label']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -116,7 +125,8 @@ module Tremendous
       return true if self.equal?(o)
       self.class == o.class &&
           id == o.id &&
-          value == o.value
+          value == o.value &&
+          label == o.label
     end
 
     # @see the `==` method
@@ -128,7 +138,7 @@ module Tremendous
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, value].hash
+      [id, value, label].hash
     end
 
     # Builds the object from hash

data/lib/tremendous/models/get_member200_response_member.rb

@@ -24,7 +24,10 @@ module Tremendous
     # Full name of the member
     attr_accessor :name
 
-    # Role of the member within the organization.  <table>   <thead>     <tr>       <th>Role</th>       <th>Description</th>     </tr>   </thead>     <tr>       <td><code>MEMBER</code></td>       <td>Limited permissions. Can view their own reward and order histories only.</td>     </tr>     <tr>       <td><code>ADMIN</code></td>       <td>Update organization settings, invite other members to the organization, and view all member order and reward histories within their organization.</td>     </tr>     <tr>       <td><code>DELETED</code></td>       <td>No longer a member of this organization.</td>     </tr>   <tbody>   </tbody> </table> 
+    # Is this member currently active in the organization. If `false`, the member will not be able to access the organization. 
+    attr_accessor :active
+
+    # Role of the member within the organization.  <table>   <thead>     <tr>       <th>Role</th>       <th>Description</th>     </tr>   </thead>     <tr>       <td><code>MEMBER</code></td>       <td>Limited permissions. Can view their own reward and order histories only.</td>     </tr>     <tr>       <td><code>ADMIN</code></td>       <td>Update organization settings, invite other members to the organization, and view all member order and reward histories within their organization.</td>     </tr>   <tbody>   </tbody> </table> 
     attr_accessor :role
 
     # Current status of the member's account.  When creating a member it starts out in the status `INVITED`. As soon as that member open the invitation link and registers an account, the status switches to `REGISTERED`. 
@@ -61,6 +64,7 @@ module Tremendous
         :'id' => :'id',
         :'email' => :'email',
         :'name' => :'name',
+        :'active' => :'active',
         :'role' => :'role',
         :'status' => :'status',
         :'events' => :'events'
@@ -78,6 +82,7 @@ module Tremendous
         :'id' => :'String',
         :'email' => :'String',
         :'name' => :'String',
+        :'active' => :'Boolean',
         :'role' => :'String',
         :'status' => :'String',
         :'events' => :'Array<GetMember200ResponseMemberEventsInner>'
@@ -124,6 +129,10 @@ module Tremendous
         self.name = nil
       end
 
+      if attributes.key?(:'active')
+        self.active = attributes[:'active']
+      end
+
       if attributes.key?(:'role')
         self.role = attributes[:'role']
       else
@@ -180,7 +189,7 @@ module Tremendous
       return false if @id !~ Regexp.new(/[A-Z0-9]{4,20}/)
       return false if @email.nil?
       return false if @role.nil?
-      role_validator = EnumAttributeValidator.new('String', ["MEMBER", "ADMIN", "DELETED"])
+      role_validator = EnumAttributeValidator.new('String', ["MEMBER", "ADMIN"])
       return false unless role_validator.valid?(@role)
       return false if @status.nil?
       status_validator = EnumAttributeValidator.new('String', ["REGISTERED", "INVITED"])
@@ -206,7 +215,7 @@ module Tremendous
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] role Object to be assigned
     def role=(role)
-      validator = EnumAttributeValidator.new('String', ["MEMBER", "ADMIN", "DELETED"])
+      validator = EnumAttributeValidator.new('String', ["MEMBER", "ADMIN"])
       unless validator.valid?(role)
         fail ArgumentError, "invalid value for \"role\", must be one of #{validator.allowable_values}."
       end
@@ -231,6 +240,7 @@ module Tremendous
           id == o.id &&
           email == o.email &&
           name == o.name &&
+          active == o.active &&
           role == o.role &&
           status == o.status &&
           events == o.events
@@ -245,7 +255,7 @@ module Tremendous
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, email, name, role, status, events].hash
+      [id, email, name, active, role, status, events].hash
     end
 
     # Builds the object from hash

data/lib/tremendous/models/invoice.rb

@@ -90,8 +90,8 @@ module Tremendous
         :'status' => :'String',
         :'orders' => :'Array<String>',
         :'rewards' => :'Array<String>',
-        :'created_at' => :'Date',
-        :'paid_at' => :'Date'
+        :'created_at' => :'Time',
+        :'paid_at' => :'Time'
       }
     end