talon_one 2.4.0 → 3.0.0

data/lib/talon_one/models/role_v2_permissions_roles.rb

@@ -0,0 +1,230 @@
+=begin
+#Talon.One API
+
+#Use the Talon.One API to integrate with your application and to manage applications and campaigns:  - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns.  ## Determining the base URL of the endpoints  The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` 
+
+The version of the OpenAPI document: 
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'date'
+
+module TalonOne
+  class RoleV2PermissionsRoles
+    attr_accessor :applications
+
+    attr_accessor :loyalty_programs
+
+    attr_accessor :campaign_access_groups
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'applications' => :'applications',
+        :'loyalty_programs' => :'loyaltyPrograms',
+        :'campaign_access_groups' => :'campaignAccessGroups'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'applications' => :'Hash<String, RoleV2ApplicationDetails>',
+        :'loyalty_programs' => :'Hash<String, String>',
+        :'campaign_access_groups' => :'Hash<String, String>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @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 `TalonOne::RoleV2PermissionsRoles` 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 `TalonOne::RoleV2PermissionsRoles`. 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?(:'applications')
+        if (value = attributes[:'applications']).is_a?(Hash)
+          self.applications = value
+        end
+      end
+
+      if attributes.key?(:'loyalty_programs')
+        if (value = attributes[:'loyalty_programs']).is_a?(Hash)
+          self.loyalty_programs = value
+        end
+      end
+
+      if attributes.key?(:'campaign_access_groups')
+        if (value = attributes[:'campaign_access_groups']).is_a?(Hash)
+          self.campaign_access_groups = value
+        end
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    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 &&
+          applications == o.applications &&
+          loyalty_programs == o.loyalty_programs &&
+          campaign_access_groups == o.campaign_access_groups
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [applications, loyalty_programs, campaign_access_groups].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.openapi_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        TalonOne.const_get(type).build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+        
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+  end
+end

data/lib/talon_one/models/rollback_added_loyalty_points_effect_props.rb

@@ -1,9 +1,9 @@
 =begin
 #Talon.One API
 
-#The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns.  ### Where is the API?  The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id`  [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put 
+#Use the Talon.One API to integrate with your application and to manage applications and campaigns:  - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns.  ## Determining the base URL of the endpoints  The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` 
 
-The version of the OpenAPI document: 1.0.0
+The version of the OpenAPI document: 
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.3.1
@@ -15,21 +15,30 @@ require 'date'
 module TalonOne
   # The properties specific to the \"rollbackAddedLoyaltyPoints\" effect. This gets triggered whenever previously a closed session with an addLoyaltyPoints effect is cancelled.
   class RollbackAddedLoyaltyPointsEffectProps
-    # The ID of the loyalty program where the points were originally added
+    # The ID of the loyalty program where the points were originally added.
     attr_accessor :program_id
 
-    # The ID of the subledger within the loyalty program where these points were originally added
+    # The ID of the subledger within the loyalty program where these points were originally added.
     attr_accessor :sub_ledger_id
 
-    # The amount of points that were rolled back
+    # The amount of points that were rolled back.
     attr_accessor :value
 
-    # The user for whom these points were originally added
+    # The user for whom these points were originally added.
     attr_accessor :recipient_integration_id
 
     # The identifier of 'deduction' entry added to the ledger as the `addLoyaltyPoints` effect is rolled back.
     attr_accessor :transaction_uuid
 
+    # The index of the item in the cart items for which the loyalty points were rolled back.
+    attr_accessor :cart_item_position
+
+    # The sub-position is returned when [cart item flattening](https://docs.talon.one/docs/product/campaigns/campaign-evaluation#flattening) is enabled. It indicates to which item the loyalty points were rolled back, for cart items with `quantity` > 1. 
+    attr_accessor :cart_item_sub_position
+
+    # The alphanumeric identifier of the loyalty card. 
+    attr_accessor :card_identifier
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -37,7 +46,10 @@ module TalonOne
         :'sub_ledger_id' => :'subLedgerId',
         :'value' => :'value',
         :'recipient_integration_id' => :'recipientIntegrationId',
-        :'transaction_uuid' => :'transactionUUID'
+        :'transaction_uuid' => :'transactionUUID',
+        :'cart_item_position' => :'cartItemPosition',
+        :'cart_item_sub_position' => :'cartItemSubPosition',
+        :'card_identifier' => :'cardIdentifier'
       }
     end
 
@@ -48,7 +60,10 @@ module TalonOne
         :'sub_ledger_id' => :'String',
         :'value' => :'Float',
         :'recipient_integration_id' => :'String',
-        :'transaction_uuid' => :'String'
+        :'transaction_uuid' => :'String',
+        :'cart_item_position' => :'Float',
+        :'cart_item_sub_position' => :'Float',
+        :'card_identifier' => :'String'
       }
     end
 
@@ -92,6 +107,18 @@ module TalonOne
       if attributes.key?(:'transaction_uuid')
         self.transaction_uuid = attributes[:'transaction_uuid']
       end
+
+      if attributes.key?(:'cart_item_position')
+        self.cart_item_position = attributes[:'cart_item_position']
+      end
+
+      if attributes.key?(:'cart_item_sub_position')
+        self.cart_item_sub_position = attributes[:'cart_item_sub_position']
+      end
+
+      if attributes.key?(:'card_identifier')
+        self.card_identifier = attributes[:'card_identifier']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -114,10 +141,18 @@ module TalonOne
         invalid_properties.push('invalid value for "recipient_integration_id", recipient_integration_id cannot be nil.')
       end
 
+      if @recipient_integration_id.to_s.length > 1000
+        invalid_properties.push('invalid value for "recipient_integration_id", the character length must be smaller than or equal to 1000.')
+      end
+
       if @transaction_uuid.nil?
         invalid_properties.push('invalid value for "transaction_uuid", transaction_uuid cannot be nil.')
       end
 
+      if !@card_identifier.nil? && @card_identifier.to_s.length > 108
+        invalid_properties.push('invalid value for "card_identifier", the character length must be smaller than or equal to 108.')
+      end
+
       invalid_properties
     end
 
@@ -128,10 +163,36 @@ module TalonOne
       return false if @sub_ledger_id.nil?
       return false if @value.nil?
       return false if @recipient_integration_id.nil?
+      return false if @recipient_integration_id.to_s.length > 1000
       return false if @transaction_uuid.nil?
+      return false if !@card_identifier.nil? && @card_identifier.to_s.length > 108
       true
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] recipient_integration_id Value to be assigned
+    def recipient_integration_id=(recipient_integration_id)
+      if recipient_integration_id.nil?
+        fail ArgumentError, 'recipient_integration_id cannot be nil'
+      end
+
+      if recipient_integration_id.to_s.length > 1000
+        fail ArgumentError, 'invalid value for "recipient_integration_id", the character length must be smaller than or equal to 1000.'
+      end
+
+      @recipient_integration_id = recipient_integration_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] card_identifier Value to be assigned
+    def card_identifier=(card_identifier)
+      if !card_identifier.nil? && card_identifier.to_s.length > 108
+        fail ArgumentError, 'invalid value for "card_identifier", the character length must be smaller than or equal to 108.'
+      end
+
+      @card_identifier = card_identifier
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -141,7 +202,10 @@ module TalonOne
           sub_ledger_id == o.sub_ledger_id &&
           value == o.value &&
           recipient_integration_id == o.recipient_integration_id &&
-          transaction_uuid == o.transaction_uuid
+          transaction_uuid == o.transaction_uuid &&
+          cart_item_position == o.cart_item_position &&
+          cart_item_sub_position == o.cart_item_sub_position &&
+          card_identifier == o.card_identifier
     end
 
     # @see the `==` method
@@ -153,7 +217,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [program_id, sub_ledger_id, value, recipient_integration_id, transaction_uuid].hash
+      [program_id, sub_ledger_id, value, recipient_integration_id, transaction_uuid, cart_item_position, cart_item_sub_position, card_identifier].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/rollback_coupon_effect_props.rb

@@ -1,9 +1,9 @@
 =begin
 #Talon.One API
 
-#The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns.  ### Where is the API?  The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id`  [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put 
+#Use the Talon.One API to integrate with your application and to manage applications and campaigns:  - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns.  ## Determining the base URL of the endpoints  The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` 
 
-The version of the OpenAPI document: 1.0.0
+The version of the OpenAPI document: 
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.3.1
@@ -15,7 +15,7 @@ require 'date'
 module TalonOne
   # The properties specific to the \"rollbackCoupon\" effect. This gets triggered whenever previously closed session is now cancelled and a coupon redemption was cancelled on our internal usage limit counters.
   class RollbackCouponEffectProps
-    # The coupon code whose usage has been rolled back
+    # The coupon code whose usage has been rolled back.
     attr_accessor :value
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/talon_one/models/rollback_deducted_loyalty_points_effect_props.rb

@@ -1,9 +1,9 @@
 =begin
 #Talon.One API
 
-#The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns.  ### Where is the API?  The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id`  [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put 
+#Use the Talon.One API to integrate with your application and to manage applications and campaigns:  - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns.  ## Determining the base URL of the endpoints  The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` 
 
-The version of the OpenAPI document: 1.0.0
+The version of the OpenAPI document: 
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.3.1
@@ -15,27 +15,30 @@ require 'date'
 module TalonOne
   # The properties specific to the \"rollbackDeductedLoyaltyPoints\" effect. This effect is triggered whenever a previously closed session is cancelled and a deductLoyaltyPoints effect was revoked.
   class RollbackDeductedLoyaltyPointsEffectProps
-    # The ID of the loyalty program where these points were reimbursed
+    # The ID of the loyalty program where these points were reimbursed.
     attr_accessor :program_id
 
-    # The ID of the subledger within the loyalty program where these points were reimbursed
+    # The ID of the subledger within the loyalty program where these points were reimbursed.
     attr_accessor :sub_ledger_id
 
-    # The amount of reimbursed points that were added
+    # The amount of reimbursed points that were added.
     attr_accessor :value
 
-    # The user for whom these points were reimbursed
+    # The user for whom these points were reimbursed.
     attr_accessor :recipient_integration_id
 
-    # Date after which the reimbursed points will be valid
+    # Date after which the reimbursed points will be valid.
     attr_accessor :start_date
 
-    # Date after which the reimbursed points will expire
+    # Date after which the reimbursed points will expire.
     attr_accessor :expiry_date
 
-    # The identifier of 'addition' entries added to the ledger as the `deductLoyaltyPoints` effect is rolled back
+    # The identifier of 'addition' entries added to the ledger as the `deductLoyaltyPoints` effect is rolled back.
     attr_accessor :transaction_uuid
 
+    # The alphanumeric identifier of the loyalty card. 
+    attr_accessor :card_identifier
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -45,7 +48,8 @@ module TalonOne
         :'recipient_integration_id' => :'recipientIntegrationId',
         :'start_date' => :'startDate',
         :'expiry_date' => :'expiryDate',
-        :'transaction_uuid' => :'transactionUUID'
+        :'transaction_uuid' => :'transactionUUID',
+        :'card_identifier' => :'cardIdentifier'
       }
     end
 
@@ -58,7 +62,8 @@ module TalonOne
         :'recipient_integration_id' => :'String',
         :'start_date' => :'DateTime',
         :'expiry_date' => :'DateTime',
-        :'transaction_uuid' => :'String'
+        :'transaction_uuid' => :'String',
+        :'card_identifier' => :'String'
       }
     end
 
@@ -110,6 +115,10 @@ module TalonOne
       if attributes.key?(:'transaction_uuid')
         self.transaction_uuid = attributes[:'transaction_uuid']
       end
+
+      if attributes.key?(:'card_identifier')
+        self.card_identifier = attributes[:'card_identifier']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -132,10 +141,18 @@ module TalonOne
         invalid_properties.push('invalid value for "recipient_integration_id", recipient_integration_id cannot be nil.')
       end
 
+      if @recipient_integration_id.to_s.length > 1000
+        invalid_properties.push('invalid value for "recipient_integration_id", the character length must be smaller than or equal to 1000.')
+      end
+
       if @transaction_uuid.nil?
         invalid_properties.push('invalid value for "transaction_uuid", transaction_uuid cannot be nil.')
       end
 
+      if !@card_identifier.nil? && @card_identifier.to_s.length > 108
+        invalid_properties.push('invalid value for "card_identifier", the character length must be smaller than or equal to 108.')
+      end
+
       invalid_properties
     end
 
@@ -146,10 +163,36 @@ module TalonOne
       return false if @sub_ledger_id.nil?
       return false if @value.nil?
       return false if @recipient_integration_id.nil?
+      return false if @recipient_integration_id.to_s.length > 1000
       return false if @transaction_uuid.nil?
+      return false if !@card_identifier.nil? && @card_identifier.to_s.length > 108
       true
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] recipient_integration_id Value to be assigned
+    def recipient_integration_id=(recipient_integration_id)
+      if recipient_integration_id.nil?
+        fail ArgumentError, 'recipient_integration_id cannot be nil'
+      end
+
+      if recipient_integration_id.to_s.length > 1000
+        fail ArgumentError, 'invalid value for "recipient_integration_id", the character length must be smaller than or equal to 1000.'
+      end
+
+      @recipient_integration_id = recipient_integration_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] card_identifier Value to be assigned
+    def card_identifier=(card_identifier)
+      if !card_identifier.nil? && card_identifier.to_s.length > 108
+        fail ArgumentError, 'invalid value for "card_identifier", the character length must be smaller than or equal to 108.'
+      end
+
+      @card_identifier = card_identifier
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -161,7 +204,8 @@ module TalonOne
           recipient_integration_id == o.recipient_integration_id &&
           start_date == o.start_date &&
           expiry_date == o.expiry_date &&
-          transaction_uuid == o.transaction_uuid
+          transaction_uuid == o.transaction_uuid &&
+          card_identifier == o.card_identifier
     end
 
     # @see the `==` method
@@ -173,7 +217,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [program_id, sub_ledger_id, value, recipient_integration_id, start_date, expiry_date, transaction_uuid].hash
+      [program_id, sub_ledger_id, value, recipient_integration_id, start_date, expiry_date, transaction_uuid, card_identifier].hash
     end
 
     # Builds the object from hash