talon_one 5.0.0 → 6.0.0

data/lib/talon_one/models/scim_users_list_response.rb

@@ -0,0 +1,236 @@
+=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
+  # List of users that have been provisioned using the SCIM protocol with an identity provider, for example, Microsoft Entra ID.
+  class ScimUsersListResponse
+    attr_accessor :resources
+
+    # SCIM schema for the given resource.
+    attr_accessor :schemas
+
+    # Number of total results in the response.
+    attr_accessor :total_results
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'resources' => :'Resources',
+        :'schemas' => :'schemas',
+        :'total_results' => :'totalResults'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'resources' => :'Array<ScimUser>',
+        :'schemas' => :'Array<String>',
+        :'total_results' => :'Integer'
+      }
+    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::ScimUsersListResponse` 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::ScimUsersListResponse`. 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?(:'resources')
+        if (value = attributes[:'resources']).is_a?(Array)
+          self.resources = value
+        end
+      end
+
+      if attributes.key?(:'schemas')
+        if (value = attributes[:'schemas']).is_a?(Array)
+          self.schemas = value
+        end
+      end
+
+      if attributes.key?(:'total_results')
+        self.total_results = attributes[:'total_results']
+      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
+      if @resources.nil?
+        invalid_properties.push('invalid value for "resources", resources cannot be nil.')
+      end
+
+      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?
+      return false if @resources.nil?
+      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 &&
+          resources == o.resources &&
+          schemas == o.schemas &&
+          total_results == o.total_results
+    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
+      [resources, schemas, total_results].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/sso_config.rb

@@ -17,17 +17,22 @@ module TalonOne
     # An indication of whether single sign-on is enforced for the account. When enforced, users cannot use their email and password to sign in to Talon.One. It is not possible to change this to `false` after it is set to `true`. 
     attr_accessor :enforced
 
+    # Assertion Consumer Service (ACS) URL for setting up a new SAML connection with an identity provider like Okta or Microsoft Entra ID. 
+    attr_accessor :new_acs_url
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'enforced' => :'enforced'
+        :'enforced' => :'enforced',
+        :'new_acs_url' => :'newAcsUrl'
       }
     end
 
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'enforced' => :'Boolean'
+        :'enforced' => :'Boolean',
+        :'new_acs_url' => :'String'
       }
     end
 
@@ -55,6 +60,10 @@ module TalonOne
       if attributes.key?(:'enforced')
         self.enforced = attributes[:'enforced']
       end
+
+      if attributes.key?(:'new_acs_url')
+        self.new_acs_url = attributes[:'new_acs_url']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -80,7 +89,8 @@ module TalonOne
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          enforced == o.enforced
+          enforced == o.enforced &&
+          new_acs_url == o.new_acs_url
     end
 
     # @see the `==` method
@@ -92,7 +102,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [enforced].hash
+      [enforced, new_acs_url].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/tier.rb

@@ -20,10 +20,13 @@ module TalonOne
     # The name of the tier.
     attr_accessor :name
 
+    # Date and time when the customer moved to this tier. This value uses the loyalty program's time zone setting.
+    attr_accessor :start_date
+
     # Date when tier level expires in the RFC3339 format (in the Loyalty Program's timezone).
     attr_accessor :expiry_date
 
-    # Customers's tier downgrade policy. - `one_down`: Once the tier expires and if the user doesn't have enough points to stay in the tier, the user is downgraded one tier down. - `balance_based`: Once the tier expires, the user's tier is evaluated based on the amount of active points the user has at this instant. 
+    # The policy that defines how customer tiers are downgraded in the loyalty program after tier reevaluation.  - `one_down`: If the customer doesn't have enough points to stay in the current tier, they are downgraded by one tier.  - `balance_based`: The customer's tier is reevaluated based on the amount of active points they have at the moment. 
     attr_accessor :downgrade_policy
 
     class EnumAttributeValidator
@@ -53,6 +56,7 @@ module TalonOne
       {
         :'id' => :'id',
         :'name' => :'name',
+        :'start_date' => :'startDate',
         :'expiry_date' => :'expiryDate',
         :'downgrade_policy' => :'downgradePolicy'
       }
@@ -63,6 +67,7 @@ module TalonOne
       {
         :'id' => :'Integer',
         :'name' => :'String',
+        :'start_date' => :'DateTime',
         :'expiry_date' => :'DateTime',
         :'downgrade_policy' => :'String'
       }
@@ -97,6 +102,10 @@ module TalonOne
         self.name = attributes[:'name']
       end
 
+      if attributes.key?(:'start_date')
+        self.start_date = attributes[:'start_date']
+      end
+
       if attributes.key?(:'expiry_date')
         self.expiry_date = attributes[:'expiry_date']
       end
@@ -148,6 +157,7 @@ module TalonOne
       self.class == o.class &&
           id == o.id &&
           name == o.name &&
+          start_date == o.start_date &&
           expiry_date == o.expiry_date &&
           downgrade_policy == o.downgrade_policy
     end
@@ -161,7 +171,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, name, expiry_date, downgrade_policy].hash
+      [id, name, start_date, expiry_date, downgrade_policy].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/transfer_loyalty_card.rb

@@ -17,17 +17,22 @@ module TalonOne
     # The alphanumeric identifier of the loyalty card. 
     attr_accessor :new_card_identifier
 
+    # Reason for transferring and blocking the loyalty card. 
+    attr_accessor :block_reason
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'new_card_identifier' => :'newCardIdentifier'
+        :'new_card_identifier' => :'newCardIdentifier',
+        :'block_reason' => :'blockReason'
       }
     end
 
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'new_card_identifier' => :'String'
+        :'new_card_identifier' => :'String',
+        :'block_reason' => :'String'
       }
     end
 
@@ -55,6 +60,10 @@ module TalonOne
       if attributes.key?(:'new_card_identifier')
         self.new_card_identifier = attributes[:'new_card_identifier']
       end
+
+      if attributes.key?(:'block_reason')
+        self.block_reason = attributes[:'block_reason']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -99,7 +108,8 @@ module TalonOne
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          new_card_identifier == o.new_card_identifier
+          new_card_identifier == o.new_card_identifier &&
+          block_reason == o.block_reason
     end
 
     # @see the `==` method
@@ -111,7 +121,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [new_card_identifier].hash
+      [new_card_identifier, block_reason].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/update_application.rb

@@ -58,6 +58,12 @@ module TalonOne
     # The ID of the default campaign evaluation group to which new campaigns will be added unless a different group is selected when creating the campaign.
     attr_accessor :default_evaluation_group_id
 
+    # The ID of the default Cart-Item-Filter for this application.
+    attr_accessor :default_cart_item_filter_id
+
+    # Indicates whether the campaign staging and revisions feature is enabled for the Application.  **Important:** After this feature is enabled, it cannot be disabled. 
+    attr_accessor :enable_campaign_state_management
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -97,7 +103,9 @@ module TalonOne
         :'sandbox' => :'sandbox',
         :'enable_partial_discounts' => :'enablePartialDiscounts',
         :'default_discount_additional_cost_per_item_scope' => :'defaultDiscountAdditionalCostPerItemScope',
-        :'default_evaluation_group_id' => :'defaultEvaluationGroupId'
+        :'default_evaluation_group_id' => :'defaultEvaluationGroupId',
+        :'default_cart_item_filter_id' => :'defaultCartItemFilterId',
+        :'enable_campaign_state_management' => :'enableCampaignStateManagement'
       }
     end
 
@@ -118,7 +126,9 @@ module TalonOne
         :'sandbox' => :'Boolean',
         :'enable_partial_discounts' => :'Boolean',
         :'default_discount_additional_cost_per_item_scope' => :'String',
-        :'default_evaluation_group_id' => :'Integer'
+        :'default_evaluation_group_id' => :'Integer',
+        :'default_cart_item_filter_id' => :'Integer',
+        :'enable_campaign_state_management' => :'Boolean'
       }
     end
 
@@ -204,6 +214,14 @@ module TalonOne
       if attributes.key?(:'default_evaluation_group_id')
         self.default_evaluation_group_id = attributes[:'default_evaluation_group_id']
       end
+
+      if attributes.key?(:'default_cart_item_filter_id')
+        self.default_cart_item_filter_id = attributes[:'default_cart_item_filter_id']
+      end
+
+      if attributes.key?(:'enable_campaign_state_management')
+        self.enable_campaign_state_management = attributes[:'enable_campaign_state_management']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -346,7 +364,9 @@ module TalonOne
           sandbox == o.sandbox &&
           enable_partial_discounts == o.enable_partial_discounts &&
           default_discount_additional_cost_per_item_scope == o.default_discount_additional_cost_per_item_scope &&
-          default_evaluation_group_id == o.default_evaluation_group_id
+          default_evaluation_group_id == o.default_evaluation_group_id &&
+          default_cart_item_filter_id == o.default_cart_item_filter_id &&
+          enable_campaign_state_management == o.enable_campaign_state_management
     end
 
     # @see the `==` method
@@ -358,7 +378,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [name, description, timezone, currency, case_sensitivity, attributes, limits, default_discount_scope, enable_cascading_discounts, enable_flattened_cart_items, attributes_settings, sandbox, enable_partial_discounts, default_discount_additional_cost_per_item_scope, default_evaluation_group_id].hash
+      [name, description, timezone, currency, case_sensitivity, attributes, limits, default_discount_scope, enable_cascading_discounts, enable_flattened_cart_items, attributes_settings, sandbox, enable_partial_discounts, default_discount_additional_cost_per_item_scope, default_evaluation_group_id, default_cart_item_filter_id, enable_campaign_state_management].hash
     end
 
     # Builds the object from hash