talon_one 5.0.0 → 7.0.0

data/lib/talon_one/models/loyalty_tier.rb

@@ -13,7 +13,7 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module TalonOne
-  # 
+  # A tier in a loyalty program.
   class LoyaltyTier
     # Internal ID of this entity.
     attr_accessor :id
@@ -24,10 +24,16 @@ module TalonOne
     # The ID of the loyalty program that owns this entity.
     attr_accessor :program_id
 
-    # The name of the tier
+    # The integration name of the loyalty program that owns this entity.
+    attr_accessor :program_name
+
+    # The Campaign Manager-displayed name of the loyalty program that owns this entity.
+    attr_accessor :program_title
+
+    # The name of the tier.
     attr_accessor :name
 
-    # The minimum amount of points required to be eligible for the tier.
+    # The minimum amount of points required to enter the tier.
     attr_accessor :min_points
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -36,6 +42,8 @@ module TalonOne
         :'id' => :'id',
         :'created' => :'created',
         :'program_id' => :'programID',
+        :'program_name' => :'programName',
+        :'program_title' => :'programTitle',
         :'name' => :'name',
         :'min_points' => :'minPoints'
       }
@@ -47,6 +55,8 @@ module TalonOne
         :'id' => :'Integer',
         :'created' => :'DateTime',
         :'program_id' => :'Integer',
+        :'program_name' => :'String',
+        :'program_title' => :'String',
         :'name' => :'String',
         :'min_points' => :'Float'
       }
@@ -85,6 +95,14 @@ module TalonOne
         self.program_id = attributes[:'program_id']
       end
 
+      if attributes.key?(:'program_name')
+        self.program_name = attributes[:'program_name']
+      end
+
+      if attributes.key?(:'program_title')
+        self.program_title = attributes[:'program_title']
+      end
+
       if attributes.key?(:'name')
         self.name = attributes[:'name']
       end
@@ -168,6 +186,8 @@ module TalonOne
           id == o.id &&
           created == o.created &&
           program_id == o.program_id &&
+          program_name == o.program_name &&
+          program_title == o.program_title &&
           name == o.name &&
           min_points == o.min_points
     end
@@ -181,7 +201,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, created, program_id, name, min_points].hash
+      [id, created, program_id, program_name, program_title, name, min_points].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/management_key.rb

@@ -13,7 +13,6 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module TalonOne
-  # 
   class ManagementKey
     # Name for management key.
     attr_accessor :name

data/lib/talon_one/models/message_log_entry.rb

@@ -30,6 +30,12 @@ module TalonOne
     # The name of the notification.
     attr_accessor :notification_name
 
+    # ID of the webhook.
+    attr_accessor :webhook_id
+
+    # The name of the webhook.
+    attr_accessor :webhook_name
+
     attr_accessor :request
 
     attr_accessor :response
@@ -37,15 +43,21 @@ module TalonOne
     # Timestamp when the log entry was created.
     attr_accessor :created_at
 
-    # The entity type the notification is related to. 
+    # The entity type the log is related to. 
     attr_accessor :entity_type
 
+    # The target URL of the request.
+    attr_accessor :url
+
     # Identifier of the Application.
     attr_accessor :application_id
 
     # Identifier of the loyalty program.
     attr_accessor :loyalty_program_id
 
+    # Identifier of the campaign.
+    attr_accessor :campaign_id
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -76,12 +88,16 @@ module TalonOne
         :'change_type' => :'changeType',
         :'notification_id' => :'notificationId',
         :'notification_name' => :'notificationName',
+        :'webhook_id' => :'webhookId',
+        :'webhook_name' => :'webhookName',
         :'request' => :'request',
         :'response' => :'response',
         :'created_at' => :'createdAt',
         :'entity_type' => :'entityType',
+        :'url' => :'url',
         :'application_id' => :'applicationId',
-        :'loyalty_program_id' => :'loyaltyProgramId'
+        :'loyalty_program_id' => :'loyaltyProgramId',
+        :'campaign_id' => :'campaignId'
       }
     end
 
@@ -93,12 +109,16 @@ module TalonOne
         :'change_type' => :'String',
         :'notification_id' => :'Integer',
         :'notification_name' => :'String',
+        :'webhook_id' => :'Integer',
+        :'webhook_name' => :'String',
         :'request' => :'MessageLogRequest',
         :'response' => :'MessageLogResponse',
         :'created_at' => :'DateTime',
         :'entity_type' => :'String',
+        :'url' => :'String',
         :'application_id' => :'Integer',
-        :'loyalty_program_id' => :'Integer'
+        :'loyalty_program_id' => :'Integer',
+        :'campaign_id' => :'Integer'
       }
     end
 
@@ -143,6 +163,14 @@ module TalonOne
         self.notification_name = attributes[:'notification_name']
       end
 
+      if attributes.key?(:'webhook_id')
+        self.webhook_id = attributes[:'webhook_id']
+      end
+
+      if attributes.key?(:'webhook_name')
+        self.webhook_name = attributes[:'webhook_name']
+      end
+
       if attributes.key?(:'request')
         self.request = attributes[:'request']
       end
@@ -159,6 +187,10 @@ module TalonOne
         self.entity_type = attributes[:'entity_type']
       end
 
+      if attributes.key?(:'url')
+        self.url = attributes[:'url']
+      end
+
       if attributes.key?(:'application_id')
         self.application_id = attributes[:'application_id']
       end
@@ -166,6 +198,10 @@ module TalonOne
       if attributes.key?(:'loyalty_program_id')
         self.loyalty_program_id = attributes[:'loyalty_program_id']
       end
+
+      if attributes.key?(:'campaign_id')
+        self.campaign_id = attributes[:'campaign_id']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -184,6 +220,10 @@ module TalonOne
         invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
       end
 
+      if @entity_type.nil?
+        invalid_properties.push('invalid value for "entity_type", entity_type cannot be nil.')
+      end
+
       if !@application_id.nil? && @application_id < 1
         invalid_properties.push('invalid value for "application_id", must be greater than or equal to 1.')
       end
@@ -192,6 +232,10 @@ module TalonOne
         invalid_properties.push('invalid value for "loyalty_program_id", must be greater than or equal to 1.')
       end
 
+      if !@campaign_id.nil? && @campaign_id < 1
+        invalid_properties.push('invalid value for "campaign_id", must be greater than or equal to 1.')
+      end
+
       invalid_properties
     end
 
@@ -201,17 +245,19 @@ module TalonOne
       return false if @id.nil?
       return false if @service.nil?
       return false if @created_at.nil?
-      entity_type_validator = EnumAttributeValidator.new('String', ["application", "loyalty_program"])
+      return false if @entity_type.nil?
+      entity_type_validator = EnumAttributeValidator.new('String', ["application", "loyalty_program", "webhook"])
       return false unless entity_type_validator.valid?(@entity_type)
       return false if !@application_id.nil? && @application_id < 1
       return false if !@loyalty_program_id.nil? && @loyalty_program_id < 1
+      return false if !@campaign_id.nil? && @campaign_id < 1
       true
     end
 
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] entity_type Object to be assigned
     def entity_type=(entity_type)
-      validator = EnumAttributeValidator.new('String', ["application", "loyalty_program"])
+      validator = EnumAttributeValidator.new('String', ["application", "loyalty_program", "webhook"])
       unless validator.valid?(entity_type)
         fail ArgumentError, "invalid value for \"entity_type\", must be one of #{validator.allowable_values}."
       end
@@ -238,6 +284,16 @@ module TalonOne
       @loyalty_program_id = loyalty_program_id
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] campaign_id Value to be assigned
+    def campaign_id=(campaign_id)
+      if !campaign_id.nil? && campaign_id < 1
+        fail ArgumentError, 'invalid value for "campaign_id", must be greater than or equal to 1.'
+      end
+
+      @campaign_id = campaign_id
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -248,12 +304,16 @@ module TalonOne
           change_type == o.change_type &&
           notification_id == o.notification_id &&
           notification_name == o.notification_name &&
+          webhook_id == o.webhook_id &&
+          webhook_name == o.webhook_name &&
           request == o.request &&
           response == o.response &&
           created_at == o.created_at &&
           entity_type == o.entity_type &&
+          url == o.url &&
           application_id == o.application_id &&
-          loyalty_program_id == o.loyalty_program_id
+          loyalty_program_id == o.loyalty_program_id &&
+          campaign_id == o.campaign_id
     end
 
     # @see the `==` method
@@ -265,7 +325,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, service, change_type, notification_id, notification_name, request, response, created_at, entity_type, application_id, loyalty_program_id].hash
+      [id, service, change_type, notification_id, notification_name, webhook_id, webhook_name, request, response, created_at, entity_type, url, application_id, loyalty_program_id, campaign_id].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/message_log_response.rb

@@ -80,45 +80,26 @@ module TalonOne
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      if @created_at.nil?
-        invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
-      end
-
-      if @response.nil?
-        invalid_properties.push('invalid value for "response", response cannot be nil.')
-      end
-
       pattern = Regexp.new(/^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/)
-      if @response !~ pattern
+      if !@response.nil? && @response !~ pattern
         invalid_properties.push("invalid value for \"response\", must conform to the pattern #{pattern}.")
       end
 
-      if @status.nil?
-        invalid_properties.push('invalid value for "status", status 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 @created_at.nil?
-      return false if @response.nil?
-      return false if @response !~ Regexp.new(/^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/)
-      return false if @status.nil?
+      return false if !@response.nil? && @response !~ Regexp.new(/^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/)
       true
     end
 
     # Custom attribute writer method with validation
     # @param [Object] response Value to be assigned
     def response=(response)
-      if response.nil?
-        fail ArgumentError, 'response cannot be nil'
-      end
-
       pattern = Regexp.new(/^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/)
-      if response !~ pattern
+      if !response.nil? && response !~ pattern
         fail ArgumentError, "invalid value for \"response\", must conform to the pattern #{pattern}."
       end
 

data/lib/talon_one/models/model_return.rb

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

data/lib/talon_one/models/multiple_audiences_item.rb

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

data/lib/talon_one/models/multiple_customer_profile_integration_request_item.rb

@@ -13,7 +13,7 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module TalonOne
-  # 
+  # The body of a V2 integration API request (customer profile update). Next to the customer profile details, this contains an optional listing of extra properties that should be returned in the response. 
   class MultipleCustomerProfileIntegrationRequestItem
     # Arbitrary properties associated with this item.
     attr_accessor :attributes

data/lib/talon_one/models/new_account_sign_up.rb

@@ -13,7 +13,6 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module TalonOne
-  # 
   class NewAccountSignUp
     # The email address associated with the user profile.
     attr_accessor :email

data/lib/talon_one/models/new_additional_cost.rb

@@ -13,7 +13,6 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module TalonOne
-  # 
   class NewAdditionalCost
     # The internal name used in API requests.
     attr_accessor :name

data/lib/talon_one/models/new_app_wide_coupon_deletion_job.rb

@@ -0,0 +1,227 @@
+=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 NewAppWideCouponDeletionJob
+    attr_accessor :filters
+
+    attr_accessor :campaignids
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'filters' => :'filters',
+        :'campaignids' => :'campaignids'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'filters' => :'CouponDeletionFilters',
+        :'campaignids' => :'Array<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::NewAppWideCouponDeletionJob` 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::NewAppWideCouponDeletionJob`. 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?(:'filters')
+        self.filters = attributes[:'filters']
+      end
+
+      if attributes.key?(:'campaignids')
+        if (value = attributes[:'campaignids']).is_a?(Array)
+          self.campaignids = 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
+      if @filters.nil?
+        invalid_properties.push('invalid value for "filters", filters cannot be nil.')
+      end
+
+      if @campaignids.nil?
+        invalid_properties.push('invalid value for "campaignids", campaignids 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 @filters.nil?
+      return false if @campaignids.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 &&
+          filters == o.filters &&
+          campaignids == o.campaignids
+    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
+      [filters, campaignids].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/new_application.rb

@@ -58,6 +58,9 @@ module TalonOne
     # Hex key for HMAC-signing API calls as coming from this application (16 hex digits).
     attr_accessor :key
 
+    # 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 +100,8 @@ module TalonOne
         :'sandbox' => :'sandbox',
         :'enable_partial_discounts' => :'enablePartialDiscounts',
         :'default_discount_additional_cost_per_item_scope' => :'defaultDiscountAdditionalCostPerItemScope',
-        :'key' => :'key'
+        :'key' => :'key',
+        :'enable_campaign_state_management' => :'enableCampaignStateManagement'
       }
     end
 
@@ -118,7 +122,8 @@ module TalonOne
         :'sandbox' => :'Boolean',
         :'enable_partial_discounts' => :'Boolean',
         :'default_discount_additional_cost_per_item_scope' => :'String',
-        :'key' => :'String'
+        :'key' => :'String',
+        :'enable_campaign_state_management' => :'Boolean'
       }
     end
 
@@ -204,6 +209,10 @@ module TalonOne
       if attributes.key?(:'key')
         self.key = attributes[:'key']
       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?
@@ -363,7 +372,8 @@ 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 &&
-          key == o.key
+          key == o.key &&
+          enable_campaign_state_management == o.enable_campaign_state_management
     end
 
     # @see the `==` method
@@ -375,7 +385,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, key].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, key, enable_campaign_state_management].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/new_application_api_key.rb

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