talon_one 6.0.0 → 7.0.0

data/lib/talon_one/models/analytics_product_sku.rb

@@ -0,0 +1,242 @@
+=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 AnalyticsProductSKU
+    # The ID of the SKU linked to the analytics-level product.
+    attr_accessor :id
+
+    # The SKU linked to the analytics-level product.
+    attr_accessor :sku
+
+    # Values in UTC for the date the SKU linked to the analytics-level product was last updated.
+    attr_accessor :last_updated
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'sku' => :'sku',
+        :'last_updated' => :'lastUpdated'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'id' => :'Integer',
+        :'sku' => :'String',
+        :'last_updated' => :'DateTime'
+      }
+    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::AnalyticsProductSKU` 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::AnalyticsProductSKU`. 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?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'sku')
+        self.sku = attributes[:'sku']
+      end
+
+      if attributes.key?(:'last_updated')
+        self.last_updated = attributes[:'last_updated']
+      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 @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @sku.nil?
+        invalid_properties.push('invalid value for "sku", sku cannot be nil.')
+      end
+
+      if @last_updated.nil?
+        invalid_properties.push('invalid value for "last_updated", last_updated 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 @id.nil?
+      return false if @sku.nil?
+      return false if @last_updated.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 &&
+          id == o.id &&
+          sku == o.sku &&
+          last_updated == o.last_updated
+    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
+      [id, sku, last_updated].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/application.rb

@@ -13,7 +13,6 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module TalonOne
-  # 
   class Application
     # Internal ID of this entity.
     attr_accessor :id

data/lib/talon_one/models/application_api_key.rb

@@ -13,7 +13,6 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module TalonOne
-  # 
   class ApplicationAPIKey
     # Title of the API key.
     attr_accessor :title

data/lib/talon_one/models/application_campaign_analytics.rb

@@ -214,7 +214,7 @@ module TalonOne
       return false if @campaign_name.nil?
       return false if @campaign_tags.nil?
       return false if @campaign_state.nil?
-      campaign_state_validator = EnumAttributeValidator.new('String', ["expired", "scheduled", "running", "disabled", "archived"])
+      campaign_state_validator = EnumAttributeValidator.new('String', ["expired", "scheduled", "running", "disabled", "archived", "staged"])
       return false unless campaign_state_validator.valid?(@campaign_state)
       true
     end
@@ -222,7 +222,7 @@ module TalonOne
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] campaign_state Object to be assigned
     def campaign_state=(campaign_state)
-      validator = EnumAttributeValidator.new('String', ["expired", "scheduled", "running", "disabled", "archived"])
+      validator = EnumAttributeValidator.new('String', ["expired", "scheduled", "running", "disabled", "archived", "staged"])
       unless validator.valid?(campaign_state)
         fail ArgumentError, "invalid value for \"campaign_state\", must be one of #{validator.allowable_values}."
       end

data/lib/talon_one/models/application_campaign_stats.rb

@@ -18,6 +18,9 @@ module TalonOne
     # Number of disabled campaigns.
     attr_accessor :disabled
 
+    # Number of staged campaigns.
+    attr_accessor :staged
+
     # Number of scheduled campaigns.
     attr_accessor :scheduled
 
@@ -34,6 +37,7 @@ module TalonOne
     def self.attribute_map
       {
         :'disabled' => :'disabled',
+        :'staged' => :'staged',
         :'scheduled' => :'scheduled',
         :'running' => :'running',
         :'expired' => :'expired',
@@ -45,6 +49,7 @@ module TalonOne
     def self.openapi_types
       {
         :'disabled' => :'Integer',
+        :'staged' => :'Integer',
         :'scheduled' => :'Integer',
         :'running' => :'Integer',
         :'expired' => :'Integer',
@@ -77,6 +82,10 @@ module TalonOne
         self.disabled = attributes[:'disabled']
       end
 
+      if attributes.key?(:'staged')
+        self.staged = attributes[:'staged']
+      end
+
       if attributes.key?(:'scheduled')
         self.scheduled = attributes[:'scheduled']
       end
@@ -102,6 +111,10 @@ module TalonOne
         invalid_properties.push('invalid value for "disabled", disabled cannot be nil.')
       end
 
+      if @staged.nil?
+        invalid_properties.push('invalid value for "staged", staged cannot be nil.')
+      end
+
       if @scheduled.nil?
         invalid_properties.push('invalid value for "scheduled", scheduled cannot be nil.')
       end
@@ -125,6 +138,7 @@ module TalonOne
     # @return true if the model is valid
     def valid?
       return false if @disabled.nil?
+      return false if @staged.nil?
       return false if @scheduled.nil?
       return false if @running.nil?
       return false if @expired.nil?
@@ -138,6 +152,7 @@ module TalonOne
       return true if self.equal?(o)
       self.class == o.class &&
           disabled == o.disabled &&
+          staged == o.staged &&
           scheduled == o.scheduled &&
           running == o.running &&
           expired == o.expired &&
@@ -153,7 +168,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [disabled, scheduled, running, expired, archived].hash
+      [disabled, staged, scheduled, running, expired, archived].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/application_cif.rb

@@ -13,7 +13,6 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module TalonOne
-  # 
   class ApplicationCIF
     # Internal ID of this entity.
     attr_accessor :id

data/lib/talon_one/models/application_cif_expression.rb

@@ -13,7 +13,6 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module TalonOne
-  # 
   class ApplicationCIFExpression
     # Internal ID of this entity.
     attr_accessor :id

data/lib/talon_one/models/application_customer.rb

@@ -13,21 +13,20 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module TalonOne
-  # 
   class ApplicationCustomer
-    # Internal ID of this entity. Internal ID of this entity.
+    # Internal ID of this entity.
     attr_accessor :id
 
-    # The time this entity was created. The time this entity was created. The time this entity was created. The time this entity was created.
+    # The time this entity was created.
     attr_accessor :created
 
-    # The integration ID set by your integration layer. The integration ID set by your integration layer.
+    # The integration ID set by your integration layer.
     attr_accessor :integration_id
 
     # Arbitrary properties associated with this item.
     attr_accessor :attributes
 
-    # The ID of the Talon.One account that owns this profile. The ID of the Talon.One account that owns this profile.
+    # The ID of the Talon.One account that owns this profile.
     attr_accessor :account_id
 
     # The total amount of closed sessions by a customer. A closed session is a successful purchase.

data/lib/talon_one/models/application_event.rb

@@ -13,7 +13,6 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module TalonOne
-  # 
   class ApplicationEvent
     # Internal ID of this entity.
     attr_accessor :id

data/lib/talon_one/models/application_referee.rb

@@ -13,7 +13,6 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module TalonOne
-  # 
   class ApplicationReferee
     # The ID of the application that owns this entity.
     attr_accessor :application_id

data/lib/talon_one/models/application_session.rb

@@ -13,12 +13,11 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module TalonOne
-  # 
   class ApplicationSession
     # Internal ID of this entity.
     attr_accessor :id
 
-    # The time this entity was created. The time this entity was created.
+    # The time this entity was created.
     attr_accessor :created
 
     # The integration ID set by your integration layer.

data/lib/talon_one/models/async_coupon_deletion_job_response.rb

@@ -13,7 +13,6 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module TalonOne
-  # 
   class AsyncCouponDeletionJobResponse
     # Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints.
     attr_accessor :id

data/lib/talon_one/models/attribute.rb

@@ -13,7 +13,6 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module TalonOne
-  # 
   class Attribute
     # Internal ID of this entity.
     attr_accessor :id

data/lib/talon_one/models/audience.rb

@@ -13,7 +13,6 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module TalonOne
-  # 
   class Audience
     # The ID of the account that owns this entity.
     attr_accessor :account_id

data/lib/talon_one/models/audience_customer.rb

@@ -13,12 +13,11 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module TalonOne
-  # 
   class AudienceCustomer
     # Internal ID of this entity.
     attr_accessor :id
 
-    # The time this entity was created. The time this entity was created.
+    # The time this entity was created.
     attr_accessor :created
 
     # The integration ID set by your integration layer.

data/lib/talon_one/models/base_loyalty_program.rb

@@ -55,6 +55,9 @@ module TalonOne
 
     attr_accessor :card_code_settings
 
+    # The policy that defines the rollback of points in case of a partially returned, cancelled, or reopened [customer session](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). - `only_pending`: Only pending points can be rolled back. - `within_balance`: Available active points can be rolled back if there aren't enough pending points. The active balance of the customer cannot be negative. 
+    attr_accessor :return_policy
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -93,7 +96,8 @@ module TalonOne
         :'tier_cycle_start_date' => :'tierCycleStartDate',
         :'tiers_expire_in' => :'tiersExpireIn',
         :'tiers_downgrade_policy' => :'tiersDowngradePolicy',
-        :'card_code_settings' => :'cardCodeSettings'
+        :'card_code_settings' => :'cardCodeSettings',
+        :'return_policy' => :'returnPolicy'
       }
     end
 
@@ -113,7 +117,8 @@ module TalonOne
         :'tier_cycle_start_date' => :'DateTime',
         :'tiers_expire_in' => :'String',
         :'tiers_downgrade_policy' => :'String',
-        :'card_code_settings' => :'CodeGeneratorSettings'
+        :'card_code_settings' => :'CodeGeneratorSettings',
+        :'return_policy' => :'String'
       }
     end
 
@@ -195,6 +200,10 @@ module TalonOne
       if attributes.key?(:'card_code_settings')
         self.card_code_settings = attributes[:'card_code_settings']
       end
+
+      if attributes.key?(:'return_policy')
+        self.return_policy = attributes[:'return_policy']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -218,6 +227,8 @@ module TalonOne
       return false unless tiers_expiration_policy_validator.valid?(@tiers_expiration_policy)
       tiers_downgrade_policy_validator = EnumAttributeValidator.new('String', ["one_down", "balance_based"])
       return false unless tiers_downgrade_policy_validator.valid?(@tiers_downgrade_policy)
+      return_policy_validator = EnumAttributeValidator.new('String', ["only_pending", "within_balance"])
+      return false unless return_policy_validator.valid?(@return_policy)
       true
     end
 
@@ -261,6 +272,16 @@ module TalonOne
       @tiers_downgrade_policy = tiers_downgrade_policy
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] return_policy Object to be assigned
+    def return_policy=(return_policy)
+      validator = EnumAttributeValidator.new('String', ["only_pending", "within_balance"])
+      unless validator.valid?(return_policy)
+        fail ArgumentError, "invalid value for \"return_policy\", must be one of #{validator.allowable_values}."
+      end
+      @return_policy = return_policy
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -279,7 +300,8 @@ module TalonOne
           tier_cycle_start_date == o.tier_cycle_start_date &&
           tiers_expire_in == o.tiers_expire_in &&
           tiers_downgrade_policy == o.tiers_downgrade_policy &&
-          card_code_settings == o.card_code_settings
+          card_code_settings == o.card_code_settings &&
+          return_policy == o.return_policy
     end
 
     # @see the `==` method
@@ -291,7 +313,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [title, description, subscribed_applications, default_validity, default_pending, allow_subledger, users_per_card_limit, sandbox, program_join_policy, tiers_expiration_policy, tier_cycle_start_date, tiers_expire_in, tiers_downgrade_policy, card_code_settings].hash
+      [title, description, subscribed_applications, default_validity, default_pending, allow_subledger, users_per_card_limit, sandbox, program_join_policy, tiers_expiration_policy, tier_cycle_start_date, tiers_expire_in, tiers_downgrade_policy, card_code_settings, return_policy].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/base_notification.rb

@@ -13,7 +13,6 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module TalonOne
-  # 
   class BaseNotification
     # Indicates which notification properties to apply.
     attr_accessor :policy

data/lib/talon_one/models/base_notification_webhook.rb

@@ -13,7 +13,6 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module TalonOne
-  # 
   class BaseNotificationWebhook
     # Internal ID of this entity.
     attr_accessor :id

data/lib/talon_one/models/bulk_operation_on_campaigns.rb

@@ -20,6 +20,9 @@ module TalonOne
     # The list of campaign IDs on which the operation will be performed.
     attr_accessor :campaign_ids
 
+    # Timestamp when the revisions are finalized after the `activate_revision` operation. The current time is used when left blank.  **Note:** It must be an RFC3339 timestamp string. 
+    attr_accessor :activate_at
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -46,7 +49,8 @@ module TalonOne
     def self.attribute_map
       {
         :'operation' => :'operation',
-        :'campaign_ids' => :'campaignIds'
+        :'campaign_ids' => :'campaignIds',
+        :'activate_at' => :'activateAt'
       }
     end
 
@@ -54,7 +58,8 @@ module TalonOne
     def self.openapi_types
       {
         :'operation' => :'String',
-        :'campaign_ids' => :'Array<Integer>'
+        :'campaign_ids' => :'Array<Integer>',
+        :'activate_at' => :'DateTime'
       }
     end
 
@@ -88,6 +93,10 @@ module TalonOne
           self.campaign_ids = value
         end
       end
+
+      if attributes.key?(:'activate_at')
+        self.activate_at = attributes[:'activate_at']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -109,7 +118,7 @@ module TalonOne
     # @return true if the model is valid
     def valid?
       return false if @operation.nil?
-      operation_validator = EnumAttributeValidator.new('String', ["disable", "delete"])
+      operation_validator = EnumAttributeValidator.new('String', ["disable", "delete", "activate_revision"])
       return false unless operation_validator.valid?(@operation)
       return false if @campaign_ids.nil?
       true
@@ -118,7 +127,7 @@ module TalonOne
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] operation Object to be assigned
     def operation=(operation)
-      validator = EnumAttributeValidator.new('String', ["disable", "delete"])
+      validator = EnumAttributeValidator.new('String', ["disable", "delete", "activate_revision"])
       unless validator.valid?(operation)
         fail ArgumentError, "invalid value for \"operation\", must be one of #{validator.allowable_values}."
       end
@@ -131,7 +140,8 @@ module TalonOne
       return true if self.equal?(o)
       self.class == o.class &&
           operation == o.operation &&
-          campaign_ids == o.campaign_ids
+          campaign_ids == o.campaign_ids &&
+          activate_at == o.activate_at
     end
 
     # @see the `==` method
@@ -143,7 +153,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [operation, campaign_ids].hash
+      [operation, campaign_ids, activate_at].hash
     end
 
     # Builds the object from hash