talon_one_sdk 26.01

data/lib/talon_one_sdk/models/environment.rb

@@ -0,0 +1,449 @@
+=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
+Generator version: 7.18.0
+
+=end
+
+require 'date'
+require 'time'
+
+module TalonOne
+  class Environment < ApiModelBase
+    # The internal ID of this entity.
+    attr_accessor :id
+
+    # The time this entity was created.
+    attr_accessor :created
+
+    # The ID of the Application that owns this entity.
+    attr_accessor :application_id
+
+    # The slots defined for this application.
+    attr_accessor :slots
+
+    # The functions defined for this application.
+    attr_accessor :functions
+
+    # The templates defined for this application.
+    attr_accessor :templates
+
+    # A stringified version of the environment's Talang variables scope.
+    attr_accessor :variables
+
+    # The giveaways pools that the application is subscribed to.
+    attr_accessor :giveaways_pools
+
+    # The loyalty programs that the application is subscribed to.
+    attr_accessor :loyalty_programs
+
+    # The achievements, linked to the campaigns, belonging to the application.
+    attr_accessor :achievements
+
+    # The attributes that the application is subscribed to.
+    attr_accessor :attributes
+
+    # The additional costs that the application is subscribed to.
+    attr_accessor :additional_costs
+
+    # The audiences contained in the account which the application belongs to.
+    attr_accessor :audiences
+
+    # The account-level collections that the application is subscribed to.
+    attr_accessor :collections
+
+    # The cart item filters belonging to the Application.
+    attr_accessor :application_cart_item_filters
+
+    # The price types that this Application can use.
+    attr_accessor :price_types
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'created' => :'created',
+        :'application_id' => :'applicationId',
+        :'slots' => :'slots',
+        :'functions' => :'functions',
+        :'templates' => :'templates',
+        :'variables' => :'variables',
+        :'giveaways_pools' => :'giveawaysPools',
+        :'loyalty_programs' => :'loyaltyPrograms',
+        :'achievements' => :'achievements',
+        :'attributes' => :'attributes',
+        :'additional_costs' => :'additionalCosts',
+        :'audiences' => :'audiences',
+        :'collections' => :'collections',
+        :'application_cart_item_filters' => :'applicationCartItemFilters',
+        :'price_types' => :'priceTypes'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'id' => :'Integer',
+        :'created' => :'Time',
+        :'application_id' => :'Integer',
+        :'slots' => :'Array<SlotDef>',
+        :'functions' => :'Array<FunctionDef>',
+        :'templates' => :'Array<TemplateDef>',
+        :'variables' => :'String',
+        :'giveaways_pools' => :'Array<GiveawaysPool>',
+        :'loyalty_programs' => :'Array<LoyaltyProgram>',
+        :'achievements' => :'Array<Achievement>',
+        :'attributes' => :'Array<Attribute>',
+        :'additional_costs' => :'Array<AccountAdditionalCost>',
+        :'audiences' => :'Array<Audience>',
+        :'collections' => :'Array<Collection>',
+        :'application_cart_item_filters' => :'Array<ApplicationCIF>',
+        :'price_types' => :'Array<PriceType>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # List of class defined in allOf (OpenAPI v3)
+    def self.openapi_all_of
+      [
+      :'ApplicationEntity',
+      :'Entity'
+      ]
+    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::Environment` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `TalonOne::Environment`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      else
+        self.id = nil
+      end
+
+      if attributes.key?(:'created')
+        self.created = attributes[:'created']
+      else
+        self.created = nil
+      end
+
+      if attributes.key?(:'application_id')
+        self.application_id = attributes[:'application_id']
+      else
+        self.application_id = nil
+      end
+
+      if attributes.key?(:'slots')
+        if (value = attributes[:'slots']).is_a?(Array)
+          self.slots = value
+        end
+      else
+        self.slots = nil
+      end
+
+      if attributes.key?(:'functions')
+        if (value = attributes[:'functions']).is_a?(Array)
+          self.functions = value
+        end
+      else
+        self.functions = nil
+      end
+
+      if attributes.key?(:'templates')
+        if (value = attributes[:'templates']).is_a?(Array)
+          self.templates = value
+        end
+      else
+        self.templates = nil
+      end
+
+      if attributes.key?(:'variables')
+        self.variables = attributes[:'variables']
+      else
+        self.variables = nil
+      end
+
+      if attributes.key?(:'giveaways_pools')
+        if (value = attributes[:'giveaways_pools']).is_a?(Array)
+          self.giveaways_pools = value
+        end
+      end
+
+      if attributes.key?(:'loyalty_programs')
+        if (value = attributes[:'loyalty_programs']).is_a?(Array)
+          self.loyalty_programs = value
+        end
+      end
+
+      if attributes.key?(:'achievements')
+        if (value = attributes[:'achievements']).is_a?(Array)
+          self.achievements = value
+        end
+      end
+
+      if attributes.key?(:'attributes')
+        if (value = attributes[:'attributes']).is_a?(Array)
+          self.attributes = value
+        end
+      end
+
+      if attributes.key?(:'additional_costs')
+        if (value = attributes[:'additional_costs']).is_a?(Array)
+          self.additional_costs = value
+        end
+      end
+
+      if attributes.key?(:'audiences')
+        if (value = attributes[:'audiences']).is_a?(Array)
+          self.audiences = value
+        end
+      end
+
+      if attributes.key?(:'collections')
+        if (value = attributes[:'collections']).is_a?(Array)
+          self.collections = value
+        end
+      end
+
+      if attributes.key?(:'application_cart_item_filters')
+        if (value = attributes[:'application_cart_item_filters']).is_a?(Array)
+          self.application_cart_item_filters = value
+        end
+      end
+
+      if attributes.key?(:'price_types')
+        if (value = attributes[:'price_types']).is_a?(Array)
+          self.price_types = 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
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @created.nil?
+        invalid_properties.push('invalid value for "created", created cannot be nil.')
+      end
+
+      if @application_id.nil?
+        invalid_properties.push('invalid value for "application_id", application_id cannot be nil.')
+      end
+
+      if @slots.nil?
+        invalid_properties.push('invalid value for "slots", slots cannot be nil.')
+      end
+
+      if @functions.nil?
+        invalid_properties.push('invalid value for "functions", functions cannot be nil.')
+      end
+
+      if @templates.nil?
+        invalid_properties.push('invalid value for "templates", templates cannot be nil.')
+      end
+
+      if @variables.nil?
+        invalid_properties.push('invalid value for "variables", variables 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?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @id.nil?
+      return false if @created.nil?
+      return false if @application_id.nil?
+      return false if @slots.nil?
+      return false if @functions.nil?
+      return false if @templates.nil?
+      return false if @variables.nil?
+      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
+
+      @id = id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] created Value to be assigned
+    def created=(created)
+      if created.nil?
+        fail ArgumentError, 'created cannot be nil'
+      end
+
+      @created = created
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] application_id Value to be assigned
+    def application_id=(application_id)
+      if application_id.nil?
+        fail ArgumentError, 'application_id cannot be nil'
+      end
+
+      @application_id = application_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] slots Value to be assigned
+    def slots=(slots)
+      if slots.nil?
+        fail ArgumentError, 'slots cannot be nil'
+      end
+
+      @slots = slots
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] functions Value to be assigned
+    def functions=(functions)
+      if functions.nil?
+        fail ArgumentError, 'functions cannot be nil'
+      end
+
+      @functions = functions
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] templates Value to be assigned
+    def templates=(templates)
+      if templates.nil?
+        fail ArgumentError, 'templates cannot be nil'
+      end
+
+      @templates = templates
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] variables Value to be assigned
+    def variables=(variables)
+      if variables.nil?
+        fail ArgumentError, 'variables cannot be nil'
+      end
+
+      @variables = variables
+    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 &&
+          created == o.created &&
+          application_id == o.application_id &&
+          slots == o.slots &&
+          functions == o.functions &&
+          templates == o.templates &&
+          variables == o.variables &&
+          giveaways_pools == o.giveaways_pools &&
+          loyalty_programs == o.loyalty_programs &&
+          achievements == o.achievements &&
+          attributes == o.attributes &&
+          additional_costs == o.additional_costs &&
+          audiences == o.audiences &&
+          collections == o.collections &&
+          application_cart_item_filters == o.application_cart_item_filters &&
+          price_types == o.price_types
+    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, created, application_id, slots, functions, templates, variables, giveaways_pools, loyalty_programs, achievements, attributes, additional_costs, audiences, collections, application_cart_item_filters, price_types].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)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif 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[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_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
+
+  end
+
+end

data/lib/talon_one_sdk/models/error_effect_props.rb

@@ -0,0 +1,166 @@
+=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
+Generator version: 7.18.0
+
+=end
+
+require 'date'
+require 'time'
+
+module TalonOne
+  # Whenever an error occurred during evaluation, we return an error effect. This should never happen for rules created in the rule builder.
+  class ErrorEffectProps < ApiModelBase
+    # The error message.
+    attr_accessor :message
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'message' => :'message'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'message' => :'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::ErrorEffectProps` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `TalonOne::ErrorEffectProps`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'message')
+        self.message = attributes[:'message']
+      else
+        self.message = nil
+      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
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @message.nil?
+        invalid_properties.push('invalid value for "message", message 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?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @message.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] message Value to be assigned
+    def message=(message)
+      if message.nil?
+        fail ArgumentError, 'message cannot be nil'
+      end
+
+      @message = message
+    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 &&
+          message == o.message
+    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
+      [message].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)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif 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[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_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
+
+  end
+
+end